diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 7f7a93b0a..668441bdf 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -13608,7 +13608,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record": { "post": { "summary": "Create an artifact deployment record", - "description": "Create or update deployment records for an artifact associated with an organization.\nThis endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment.", + "description": "Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.", "tags": [ "orgs" ], @@ -13681,7 +13681,7 @@ }, "deployment_name": { "type": "string", - "description": "The name of the deployment." + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n" }, "tags": { "type": "object", @@ -15894,6 +15894,16 @@ ], "default": "disabled" }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, "code_scanning_options": { "$ref": "#/components/schemas/code-scanning-options" }, @@ -16376,6 +16386,15 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -82711,6 +82730,192 @@ } } }, + "issue-comment-pinned": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-pinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-unpinned": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "issue-dependencies-blocked-by-added": { "post": { "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", @@ -102133,14 +102338,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -107031,6 +107228,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -113419,7 +113626,7 @@ }, "cli": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "description": "The organization policy for allowing or disallowing Copilot CLI.", "enum": [ "enabled", "disabled", @@ -118673,7 +118880,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118720,7 +118927,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118767,7 +118974,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118814,7 +119021,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118861,7 +119068,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -132984,6 +133191,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -143164,6 +143381,16 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -144160,13 +144387,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -145608,13 +145828,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -152339,6 +152552,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } @@ -154275,13 +154489,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -155128,13 +155335,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -155974,13 +156174,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -160211,13 +160404,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -164960,13 +165146,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -165619,13 +165798,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -169122,6 +169294,16 @@ "type": "string", "format": "uri" }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] + }, "user": { "title": "User", "type": [ @@ -170209,13 +170391,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -171850,13 +172025,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -173500,13 +173668,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -174162,244 +174323,18 @@ "sender" ] }, - "webhook-issue-dependencies-blocked-by-added": { - "title": "blocked by issue added event", + "webhook-issue-comment-pinned": { + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "blocked_by_added" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocked-by-removed": { - "title": "blocked by issue removed event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocked_by_removed" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocking-added": { - "title": "blocking issue added event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocking_added" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocked_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocking-removed": { - "title": "blocking issue removed event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocking_removed" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocked_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issues-assigned": { - "title": "issues assigned event", - "type": "object", - "properties": { - "action": { - "description": "The action that was performed.", - "type": "string", - "enum": [ - "assigned" + "pinned" ] }, - "assignee": { - "$ref": "#/components/schemas/webhooks_user" - }, - "enterprise": { - "$ref": "#/components/schemas/enterprise-webhooks" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "issue": { - "$ref": "#/components/schemas/webhooks_issue" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "issue", - "repository", - "sender" - ] - }, - "webhook-issues-closed": { - "title": "issues closed event", - "type": "object", - "properties": { - "action": { - "description": "The action that was performed.", - "type": "string", - "enum": [ - "closed" - ] + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -174408,7 +174343,7 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", @@ -175012,10 +174947,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -175270,8 +175202,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -175506,12 +175437,6 @@ "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, - "issue_field_values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -175682,9 +175607,103 @@ ] }, "assignee": { + "title": "User", "type": [ "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "assignees": { @@ -175732,9 +175751,46 @@ "labels": { "type": "array", "items": { - "type": [ - "object", - "null" + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] } }, @@ -175801,10 +175857,11 @@ "type": "string" }, "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": [ - "closed", - "open" + "open", + "closed" ] }, "timeline_url": { @@ -175884,8 +175941,10 @@ } }, "required": [ + "labels", "state", - "closed_at" + "locked", + "assignee" ] } ] @@ -175903,20 +175962,24 @@ "required": [ "action", "issue", + "comment", "repository", "sender" ] }, - "webhook-issues-deleted": { - "title": "issues deleted event", + "webhook-issue-comment-unpinned": { + "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "unpinned" ] }, + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" + }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, @@ -175924,355 +175987,3734 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", + ], "enum": [ - "Bot", - "User", - "Organization" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-added": { + "title": "blocked by issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-removed": { + "title": "blocked by issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-added": { + "title": "blocking issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-removed": { + "title": "blocking issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issues-assigned": { + "title": "issues assigned event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "assigned" + ] + }, + "assignee": { + "$ref": "#/components/schemas/webhooks_user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-closed": { + "title": "issues closed event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "security_and_analysis", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "closed", + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "closed_at" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-deleted": { + "title": "issues deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -176879,13 +180321,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178201,13 +181636,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -179492,13 +182920,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -180787,13 +184208,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -182121,13 +185535,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -183408,13 +186815,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -184665,13 +188065,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -186544,13 +189937,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -187905,13 +191291,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -189156,13 +192535,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -191248,13 +194620,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -294162,7 +297527,6 @@ "subject_type": "installation", "subject_id": 954453, "subject_name": "GitHub Actions", - "integration_id": 124345, "total_request_count": 544665, "rate_limited_request_count": 13, "last_request_timestamp": "2024-09-18T15:43:03Z", @@ -297716,7 +301080,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -297737,61 +301101,59 @@ ] }, "org-ruleset-version-with-state": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } }, "organization-secret-scanning-alert-list": { "value": [ @@ -311513,51 +314875,49 @@ } }, "repository-ruleset-version-with-state": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } }, "secret-scanning-alert-list": { "value": [ @@ -316844,7 +320204,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -316899,7 +320258,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317170,7 +320528,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317225,7 +320582,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317483,7 +320839,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317538,7 +320893,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317824,7 +321178,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317879,7 +321232,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index e597318f3..1ad61524d 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -9798,8 +9798,19 @@ paths: post: summary: Create an artifact deployment record description: |- - Create or update deployment records for an artifact associated with an organization. - This endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment. + Create or update deployment records for an artifact associated + with an organization. + This endpoint allows you to record information about a specific + artifact, such as its name, digest, environments, cluster, and + deployment. + The deployment name has to be uniqe within a cluster (i.e a + combination of logical, physical environment and cluster) as it + identifies unique deployment. + Multiple requests for the same combination of logical, physical + environment, cluster and deployment name will only create one + record, successive request will update the existing record. + This allows for a stable tracking of a deployment where the actual + deployed artifact can change over time. tags: - orgs operationId: orgs/create-artifact-deployment-record @@ -9858,7 +9869,10 @@ paths: description: The deployment cluster. deployment_name: type: string - description: The name of the deployment. + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a cluster, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. tags: type: object description: The tags associated with the deployment. @@ -11477,6 +11491,15 @@ paths: - disabled - not_set default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled code_scanning_options: "$ref": "#/components/schemas/code-scanning-options" code_scanning_default_setup: @@ -11853,6 +11876,14 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -59718,284 +59749,18 @@ webhooks: - repository - organization - app - issue-dependencies-blocked-by-added: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocked by another issue. - operationId: issue-dependencies/blocked-by-added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocked-by-removed: + 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 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: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocking relationship between an issue and another issue was - removed. - operationId: issue-dependencies/blocking-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issues-assigned: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was assigned to a user. - operationId: issues/assigned + description: A comment on an issue was pinned. + operationId: issue-comment/pinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -60037,7 +59802,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issue-comment-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60045,23 +59810,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-closed: + issue-comment-unpinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was closed. - operationId: issues/closed + description: A comment on an issue was unpinned. + operationId: issue-comment/unpinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -60103,7 +59868,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60111,23 +59876,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-deleted: + issue-dependencies-blocked-by-added: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was deleted. - operationId: issues/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocked by another issue. + operationId: issue-dependencies/blocked-by-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -60169,7 +59934,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60177,23 +59942,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-demilestoned: + issue-dependencies-blocked-by-removed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was removed from a milestone. - operationId: issues/demilestoned + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocked by relationship between an issue and another issue + was removed. + operationId: issue-dependencies/blocked-by-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -60235,7 +60001,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60243,12 +60009,145 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-edited: + issue-dependencies-blocking-added: + post: + summary: |- + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocking another issue. + operationId: issue-dependencies/blocking-added + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue-dependencies + supported-webhook-types: + - repository + - organization + - app + issue-dependencies-blocking-removed: + post: + summary: |- + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocking relationship between an issue and another issue was + removed. + operationId: issue-dependencies/blocking-removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue-dependencies + supported-webhook-types: + - repository + - organization + - app + issues-assigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60256,8 +60155,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: The title or body on an issue was edited. - operationId: issues/edited + description: An issue was assigned to a user. + operationId: issues/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60301,7 +60200,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60314,7 +60213,7 @@ webhooks: - repository - organization - app - issues-labeled: + issues-closed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60322,8 +60221,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + description: An issue was closed. + operationId: issues/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60367,7 +60266,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60380,7 +60279,7 @@ webhooks: - repository - organization - app - issues-locked: + issues-deleted: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60388,9 +60287,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue was deleted. + operationId: issues/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60434,7 +60332,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60447,7 +60345,7 @@ webhooks: - repository - organization - app - issues-milestoned: + issues-demilestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60455,8 +60353,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: An issue was removed from a milestone. + operationId: issues/demilestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60500,7 +60398,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60513,7 +60411,7 @@ webhooks: - repository - organization - app - issues-opened: + issues-edited: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60521,9 +60419,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + description: The title or body on an issue was edited. + operationId: issues/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60567,7 +60464,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60580,7 +60477,7 @@ webhooks: - repository - organization - app - issues-pinned: + issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60588,9 +60485,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + description: A label was added to an issue. + operationId: issues/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60634,7 +60530,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60647,7 +60543,7 @@ webhooks: - repository - organization - app - issues-reopened: + issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60655,8 +60551,9 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60700,7 +60597,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60713,7 +60610,7 @@ webhooks: - repository - organization - app - issues-transferred: + issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60721,9 +60618,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred + description: An issue was added to a milestone. + operationId: issues/milestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60767,7 +60663,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60780,7 +60676,7 @@ webhooks: - repository - organization - app - issues-typed: + issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60788,8 +60684,275 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was added to an issue. - operationId: issues/typed + description: An issue was created. When a closed issue is reopened, the action + will be `reopened` instead. + operationId: issues/opened + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-opened" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-pinned: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was pinned to a repository. For more information, see + "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-pinned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-reopened: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A closed issue was reopened. + operationId: issues/reopened + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-reopened" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-transferred: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was transferred to another repository. For more information, + see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-transferred" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-typed: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue type was added to an issue. + operationId: issues/typed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -73647,13 +73810,6 @@ components: enum: - read - write - team_discussions: - type: string - description: The level of permission to grant the access token to manage - team discussions and related comments. - enum: - - read - - write email_addresses: type: string description: The level of permission to grant the access token to manage @@ -77374,6 +77530,10 @@ components: - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - id - node_id @@ -82115,7 +82275,7 @@ components: cli: type: string description: The organization policy for allowing or disallowing Copilot - in the CLI. + CLI. enum: - enabled - disabled @@ -86080,7 +86240,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86114,7 +86274,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86148,7 +86308,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86182,7 +86342,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86216,7 +86376,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -96380,6 +96540,10 @@ components: - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - event - actor @@ -103639,6 +103803,10 @@ components: required: - login - id + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - url - html_url @@ -104383,11 +104551,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -105459,11 +105622,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -110514,6 +110672,7 @@ components: state: type: string enum: + - auto_dismissed - open secret-scanning-alert-resolution-webhook: type: @@ -111906,11 +112065,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -112550,11 +112704,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113187,11 +113336,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -116362,11 +116506,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -119708,11 +119847,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -120201,11 +120335,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122669,6 +122798,10 @@ components: description: URL for the issue comment type: string format: uri + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" user: title: User type: @@ -123482,11 +123615,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -124685,11 +124813,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -125895,11 +126018,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -126365,182 +126483,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 + 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 - assignee: - "$ref": "#/components/schemas/webhooks_user" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - "$ref": "#/components/schemas/webhooks_issue" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - issue - - repository - - sender - webhook-issues-closed: - title: issues closed event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - closed + - pinned + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. + the comment belongs to. allOf: - title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127005,9 +126964,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - reminder - - pull_request_review_thread external_url: type: - string @@ -127191,7 +127147,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -127358,10 +127313,2578 @@ components: "$ref": "#/components/schemas/sub-issues-summary" issue_dependencies_summary: "$ref": "#/components/schemas/issue-dependencies-summary" - issue_field_values: - type: array - items: - "$ref": "#/components/schemas/issue-field-value" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-comment-unpinned: + title: issue_comment unpinned event + type: object + properties: + action: + type: string + enum: + - unpinned + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-dependencies-blocked-by-added: + title: blocked by issue added event + type: object + properties: + action: + type: string + enum: + - blocked_by_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocked-by-removed: + title: blocked by issue removed event + type: object + properties: + action: + type: string + enum: + - blocked_by_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocking-added: + title: blocking issue added event + type: object + properties: + action: + type: string + enum: + - blocking_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocking-removed: + title: blocking issue removed event + type: object + properties: + action: + type: string + enum: + - blocking_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issues-assigned: + title: issues assigned event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - assigned + assignee: + "$ref": "#/components/schemas/webhooks_user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - repository + - sender + webhook-issues-closed: + title: issues closed event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - closed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - security_and_analysis + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -128195,997 +130718,9 @@ components: format: uri user_view_type: type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - sub_issues_summary: - "$ref": "#/components/schemas/sub-issues-summary" - issue_dependencies_summary: - "$ref": "#/components/schemas/issue-dependencies-summary" - issue_field_values: - type: array - items: - "$ref": "#/components/schemas/issue-field-value" - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: - "$ref": "#/components/schemas/issue-type" - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - issue - - repository - - sender - webhook-issues-demilestoned: - title: issues demilestoned event - type: object - properties: - action: - type: string - enum: - - demilestoned - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - assignees: - type: array - items: - title: User - type: - - object - - 'null' - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: - - object - - 'null' - required: - - id - - node_id - - url - - name - - color - - default - - description - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They can be - installed directly on organizations and user accounts and granted - access to specific repositories. They come with granular permissions - and built-in webhooks. GitHub apps are first class actors within GitHub. - type: - - object - - 'null' - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -129280,7 +130815,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -129351,11 +130885,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129374,6 +130903,16 @@ components: - string - 'null' format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -129397,17 +130936,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -129430,6 +130958,17 @@ components: url: type: string format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket repository_url: type: string format: uri @@ -129471,9 +131010,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -129533,14 +131069,36 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri user_view_type: type: string - milestone: - "$ref": "#/components/schemas/webhooks_milestone" + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -129552,34 +131110,14 @@ components: - issue - repository - sender - webhook-issues-edited: - title: issues edited event + webhook-issues-demilestoned: + title: issues demilestoned event type: object properties: action: type: string enum: - - edited - changes: - description: The changes to the issue. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title. - type: string - required: - - from + - demilestoned enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -129589,6 +131127,28 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user properties: active_lock_reason: type: @@ -129605,6 +131165,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129667,11 +131230,6 @@ components: url: type: string format: uri - user_view_type: - type: string - required: - - login - - id assignees: type: array items: @@ -129679,6 +131237,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129741,9 +131302,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -129790,7 +131348,17 @@ components: type: array items: title: Label - type: object + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description properties: color: description: '6-character hex code, without the leading #, identifying @@ -129813,14 +131381,6 @@ components: description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string format: uri-template @@ -129832,6 +131392,23 @@ components: type: - object - 'null' + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at properties: closed_at: type: @@ -129848,6 +131425,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129912,9 +131492,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id description: type: - string @@ -129954,23 +131531,6 @@ components: url: type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at node_id: type: string number: @@ -129984,6 +131544,16 @@ components: type: - object - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: @@ -130045,9 +131615,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - pull_request_review_thread - - reminder external_url: type: - string @@ -130071,6 +131638,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -130134,9 +131704,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -130302,11 +131869,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130325,16 +131887,6 @@ components: - string - 'null' format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -130358,6 +131910,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -130380,17 +131943,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -130415,11 +131967,11 @@ components: timeline_url: type: string format: uri - type: - "$ref": "#/components/schemas/issue-type" title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -130432,6 +131984,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -130497,33 +132052,8 @@ components: format: uri user_view_type: type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - label: - "$ref": "#/components/schemas/webhooks_label" + milestone: + "$ref": "#/components/schemas/webhooks_milestone" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -130532,18 +132062,37 @@ components: "$ref": "#/components/schemas/simple-user" required: - action - - changes - issue - repository - sender - webhook-issues-labeled: - title: issues labeled event + webhook-issues-edited: + title: issues edited event type: object properties: action: type: string enum: - - labeled + - edited + changes: + description: The changes to the issue. + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + title: + type: object + properties: + from: + description: The previous version of the title. + type: string + required: + - from enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -131009,6 +132558,7 @@ components: - watch - workflow_dispatch - workflow_run + - security_and_analysis - pull_request_review_thread - reminder external_url: @@ -131265,11 +132815,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -131495,17 +133040,18 @@ components: "$ref": "#/components/schemas/simple-user" required: - action + - changes - issue - repository - sender - webhook-issues-locked: - title: issues locked event + webhook-issues-labeled: + title: issues labeled event type: object properties: action: type: string enum: - - locked + - labeled enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -131515,29 +133061,6 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - locked - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user properties: active_lock_reason: type: @@ -131554,9 +133077,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131615,11 +133135,15 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id assignees: type: array items: @@ -131627,9 +133151,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131688,11 +133209,13 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri - user_view_type: - type: string + required: + - login + - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -131739,17 +133262,7 @@ components: type: array items: title: Label - type: - - object - - 'null' - required: - - id - - node_id - - url - - name - - color - - default - - description + type: object properties: color: description: '6-character hex code, without the leading #, identifying @@ -131772,36 +133285,25 @@ components: description: URL for the label type: string format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description labels_url: type: string format: uri-template locked: type: boolean - enum: - - true milestone: title: Milestone description: A collection of related issues and pull requests. type: - object - 'null' - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at properties: closed_at: type: @@ -131818,9 +133320,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131879,11 +133378,15 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id description: type: - string @@ -131923,6 +133426,23 @@ components: url: type: string format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at node_id: type: string number: @@ -131936,16 +133456,6 @@ components: type: - object - 'null' - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at properties: created_at: type: @@ -132007,8 +133517,8 @@ components: - watch - workflow_dispatch - workflow_run + - pull_request_review_thread - reminder - - security_and_analysis external_url: type: - string @@ -132032,9 +133542,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -132098,6 +133605,9 @@ components: format: uri user_view_type: type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -132192,6 +133702,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -132262,11 +133773,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -132285,6 +133791,16 @@ components: - string - 'null' format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -132308,17 +133824,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -132341,6 +133846,17 @@ components: url: type: string format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket repository_url: type: string format: uri @@ -132382,9 +133898,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -132444,11 +133957,39 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + label: + "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -132460,14 +134001,14 @@ components: - issue - repository - sender - webhook-issues-milestoned: - title: issues milestoned event + webhook-issues-locked: + title: issues locked event type: object properties: action: type: string enum: - - milestoned + - locked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -132490,6 +134031,7 @@ components: - html_url - id - labels_url + - locked - milestone - node_id - number @@ -132579,6 +134121,8 @@ components: url: type: string format: uri + user_view_type: + type: string assignees: type: array items: @@ -132650,6 +134194,8 @@ components: url: type: string format: uri + user_view_type: + type: string author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -132734,6 +134280,8 @@ components: format: uri-template locked: type: boolean + enum: + - true milestone: title: Milestone description: A collection of related issues and pull requests. @@ -132834,7 +134382,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -132964,6 +134511,7 @@ components: - workflow_dispatch - workflow_run - reminder + - security_and_analysis external_url: type: - string @@ -133147,7 +134695,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -133218,7 +134765,953 @@ components: enum: - read - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + type: + "$ref": "#/components/schemas/issue-type" + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - repository + - sender + webhook-issues-milestoned: + title: issues milestoned event + type: object + properties: + action: + type: string + enum: + - milestoned + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + assignees: + type: array + items: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can be + installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within GitHub. + type: + - object + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -134146,11 +136639,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135545,11 +138033,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136562,11 +139045,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137486,11 +139964,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139048,11 +141521,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -217046,7 +219514,6 @@ components: - subject_type: installation subject_id: 954453 subject_name: GitHub Actions - integration_id: 124345 total_request_count: 544665 rate_limited_request_count: 13 last_request_timestamp: '2024-09-18T15:43:03Z' @@ -220101,7 +222568,7 @@ components: actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' - version_id: 2 actor: id: 2 @@ -220114,11 +222581,11 @@ components: updated_at: '2024-08-23T16:29:47Z' org-ruleset-version-with-state: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 21 name: super cool ruleset @@ -231937,11 +234404,11 @@ components: updated_at: '2023-08-23T16:29:47Z' repository-ruleset-version-with-state: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 42 name: super cool ruleset @@ -236531,7 +238998,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -236582,7 +239048,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -236826,7 +239291,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -236877,7 +239341,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -237109,7 +239572,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -237160,7 +239622,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -237417,7 +239878,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -237468,7 +239928,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 7f7a93b0a..668441bdf 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -13608,7 +13608,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record": { "post": { "summary": "Create an artifact deployment record", - "description": "Create or update deployment records for an artifact associated with an organization.\nThis endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment.", + "description": "Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.", "tags": [ "orgs" ], @@ -13681,7 +13681,7 @@ }, "deployment_name": { "type": "string", - "description": "The name of the deployment." + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n" }, "tags": { "type": "object", @@ -15894,6 +15894,16 @@ ], "default": "disabled" }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, "code_scanning_options": { "$ref": "#/components/schemas/code-scanning-options" }, @@ -16376,6 +16386,15 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -82711,6 +82730,192 @@ } } }, + "issue-comment-pinned": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-pinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-unpinned": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "issue-dependencies-blocked-by-added": { "post": { "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", @@ -102133,14 +102338,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -107031,6 +107228,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -113419,7 +113626,7 @@ }, "cli": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "description": "The organization policy for allowing or disallowing Copilot CLI.", "enum": [ "enabled", "disabled", @@ -118673,7 +118880,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118720,7 +118927,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118767,7 +118974,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118814,7 +119021,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118861,7 +119068,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -132984,6 +133191,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -143164,6 +143381,16 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -144160,13 +144387,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -145608,13 +145828,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -152339,6 +152552,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } @@ -154275,13 +154489,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -155128,13 +155335,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -155974,13 +156174,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -160211,13 +160404,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -164960,13 +165146,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -165619,13 +165798,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -169122,6 +169294,16 @@ "type": "string", "format": "uri" }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] + }, "user": { "title": "User", "type": [ @@ -170209,13 +170391,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -171850,13 +172025,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -173500,13 +173668,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -174162,244 +174323,18 @@ "sender" ] }, - "webhook-issue-dependencies-blocked-by-added": { - "title": "blocked by issue added event", + "webhook-issue-comment-pinned": { + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "blocked_by_added" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocked-by-removed": { - "title": "blocked by issue removed event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocked_by_removed" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocking-added": { - "title": "blocking issue added event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocking_added" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocked_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocking-removed": { - "title": "blocking issue removed event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocking_removed" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocked_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issues-assigned": { - "title": "issues assigned event", - "type": "object", - "properties": { - "action": { - "description": "The action that was performed.", - "type": "string", - "enum": [ - "assigned" + "pinned" ] }, - "assignee": { - "$ref": "#/components/schemas/webhooks_user" - }, - "enterprise": { - "$ref": "#/components/schemas/enterprise-webhooks" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "issue": { - "$ref": "#/components/schemas/webhooks_issue" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "issue", - "repository", - "sender" - ] - }, - "webhook-issues-closed": { - "title": "issues closed event", - "type": "object", - "properties": { - "action": { - "description": "The action that was performed.", - "type": "string", - "enum": [ - "closed" - ] + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -174408,7 +174343,7 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", @@ -175012,10 +174947,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -175270,8 +175202,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -175506,12 +175437,6 @@ "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, - "issue_field_values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -175682,9 +175607,103 @@ ] }, "assignee": { + "title": "User", "type": [ "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "assignees": { @@ -175732,9 +175751,46 @@ "labels": { "type": "array", "items": { - "type": [ - "object", - "null" + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] } }, @@ -175801,10 +175857,11 @@ "type": "string" }, "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": [ - "closed", - "open" + "open", + "closed" ] }, "timeline_url": { @@ -175884,8 +175941,10 @@ } }, "required": [ + "labels", "state", - "closed_at" + "locked", + "assignee" ] } ] @@ -175903,20 +175962,24 @@ "required": [ "action", "issue", + "comment", "repository", "sender" ] }, - "webhook-issues-deleted": { - "title": "issues deleted event", + "webhook-issue-comment-unpinned": { + "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "unpinned" ] }, + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" + }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, @@ -175924,355 +175987,3734 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", + ], "enum": [ - "Bot", - "User", - "Organization" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-added": { + "title": "blocked by issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-removed": { + "title": "blocked by issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-added": { + "title": "blocking issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-removed": { + "title": "blocking issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issues-assigned": { + "title": "issues assigned event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "assigned" + ] + }, + "assignee": { + "$ref": "#/components/schemas/webhooks_user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-closed": { + "title": "issues closed event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "security_and_analysis", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "closed", + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "closed_at" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-deleted": { + "title": "issues deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -176879,13 +180321,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178201,13 +181636,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -179492,13 +182920,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -180787,13 +184208,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -182121,13 +185535,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -183408,13 +186815,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -184665,13 +188065,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -186544,13 +189937,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -187905,13 +191291,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -189156,13 +192535,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -191248,13 +194620,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -294162,7 +297527,6 @@ "subject_type": "installation", "subject_id": 954453, "subject_name": "GitHub Actions", - "integration_id": 124345, "total_request_count": 544665, "rate_limited_request_count": 13, "last_request_timestamp": "2024-09-18T15:43:03Z", @@ -297716,7 +301080,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -297737,61 +301101,59 @@ ] }, "org-ruleset-version-with-state": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } }, "organization-secret-scanning-alert-list": { "value": [ @@ -311513,51 +314875,49 @@ } }, "repository-ruleset-version-with-state": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } }, "secret-scanning-alert-list": { "value": [ @@ -316844,7 +320204,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -316899,7 +320258,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317170,7 +320528,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317225,7 +320582,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317483,7 +320839,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317538,7 +320893,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317824,7 +321178,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317879,7 +321232,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index e597318f3..1ad61524d 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -9798,8 +9798,19 @@ paths: post: summary: Create an artifact deployment record description: |- - Create or update deployment records for an artifact associated with an organization. - This endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment. + Create or update deployment records for an artifact associated + with an organization. + This endpoint allows you to record information about a specific + artifact, such as its name, digest, environments, cluster, and + deployment. + The deployment name has to be uniqe within a cluster (i.e a + combination of logical, physical environment and cluster) as it + identifies unique deployment. + Multiple requests for the same combination of logical, physical + environment, cluster and deployment name will only create one + record, successive request will update the existing record. + This allows for a stable tracking of a deployment where the actual + deployed artifact can change over time. tags: - orgs operationId: orgs/create-artifact-deployment-record @@ -9858,7 +9869,10 @@ paths: description: The deployment cluster. deployment_name: type: string - description: The name of the deployment. + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a cluster, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. tags: type: object description: The tags associated with the deployment. @@ -11477,6 +11491,15 @@ paths: - disabled - not_set default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled code_scanning_options: "$ref": "#/components/schemas/code-scanning-options" code_scanning_default_setup: @@ -11853,6 +11876,14 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -59718,284 +59749,18 @@ webhooks: - repository - organization - app - issue-dependencies-blocked-by-added: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocked by another issue. - operationId: issue-dependencies/blocked-by-added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocked-by-removed: + 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 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: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocking relationship between an issue and another issue was - removed. - operationId: issue-dependencies/blocking-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issues-assigned: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was assigned to a user. - operationId: issues/assigned + description: A comment on an issue was pinned. + operationId: issue-comment/pinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -60037,7 +59802,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issue-comment-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60045,23 +59810,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-closed: + issue-comment-unpinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was closed. - operationId: issues/closed + description: A comment on an issue was unpinned. + operationId: issue-comment/unpinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -60103,7 +59868,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60111,23 +59876,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-deleted: + issue-dependencies-blocked-by-added: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was deleted. - operationId: issues/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocked by another issue. + operationId: issue-dependencies/blocked-by-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -60169,7 +59934,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60177,23 +59942,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-demilestoned: + issue-dependencies-blocked-by-removed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was removed from a milestone. - operationId: issues/demilestoned + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocked by relationship between an issue and another issue + was removed. + operationId: issue-dependencies/blocked-by-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -60235,7 +60001,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60243,12 +60009,145 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-edited: + issue-dependencies-blocking-added: + post: + summary: |- + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocking another issue. + operationId: issue-dependencies/blocking-added + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue-dependencies + supported-webhook-types: + - repository + - organization + - app + issue-dependencies-blocking-removed: + post: + summary: |- + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocking relationship between an issue and another issue was + removed. + operationId: issue-dependencies/blocking-removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue-dependencies + supported-webhook-types: + - repository + - organization + - app + issues-assigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60256,8 +60155,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: The title or body on an issue was edited. - operationId: issues/edited + description: An issue was assigned to a user. + operationId: issues/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60301,7 +60200,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60314,7 +60213,7 @@ webhooks: - repository - organization - app - issues-labeled: + issues-closed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60322,8 +60221,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + description: An issue was closed. + operationId: issues/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60367,7 +60266,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60380,7 +60279,7 @@ webhooks: - repository - organization - app - issues-locked: + issues-deleted: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60388,9 +60287,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue was deleted. + operationId: issues/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60434,7 +60332,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60447,7 +60345,7 @@ webhooks: - repository - organization - app - issues-milestoned: + issues-demilestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60455,8 +60353,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: An issue was removed from a milestone. + operationId: issues/demilestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60500,7 +60398,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60513,7 +60411,7 @@ webhooks: - repository - organization - app - issues-opened: + issues-edited: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60521,9 +60419,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + description: The title or body on an issue was edited. + operationId: issues/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60567,7 +60464,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60580,7 +60477,7 @@ webhooks: - repository - organization - app - issues-pinned: + issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60588,9 +60485,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + description: A label was added to an issue. + operationId: issues/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60634,7 +60530,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60647,7 +60543,7 @@ webhooks: - repository - organization - app - issues-reopened: + issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60655,8 +60551,9 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60700,7 +60597,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60713,7 +60610,7 @@ webhooks: - repository - organization - app - issues-transferred: + issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60721,9 +60618,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred + description: An issue was added to a milestone. + operationId: issues/milestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60767,7 +60663,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60780,7 +60676,7 @@ webhooks: - repository - organization - app - issues-typed: + issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60788,8 +60684,275 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was added to an issue. - operationId: issues/typed + description: An issue was created. When a closed issue is reopened, the action + will be `reopened` instead. + operationId: issues/opened + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-opened" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-pinned: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was pinned to a repository. For more information, see + "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-pinned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-reopened: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A closed issue was reopened. + operationId: issues/reopened + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-reopened" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-transferred: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was transferred to another repository. For more information, + see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-transferred" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-typed: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue type was added to an issue. + operationId: issues/typed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -73647,13 +73810,6 @@ components: enum: - read - write - team_discussions: - type: string - description: The level of permission to grant the access token to manage - team discussions and related comments. - enum: - - read - - write email_addresses: type: string description: The level of permission to grant the access token to manage @@ -77374,6 +77530,10 @@ components: - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - id - node_id @@ -82115,7 +82275,7 @@ components: cli: type: string description: The organization policy for allowing or disallowing Copilot - in the CLI. + CLI. enum: - enabled - disabled @@ -86080,7 +86240,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86114,7 +86274,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86148,7 +86308,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86182,7 +86342,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86216,7 +86376,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -96380,6 +96540,10 @@ components: - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - event - actor @@ -103639,6 +103803,10 @@ components: required: - login - id + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - url - html_url @@ -104383,11 +104551,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -105459,11 +105622,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -110514,6 +110672,7 @@ components: state: type: string enum: + - auto_dismissed - open secret-scanning-alert-resolution-webhook: type: @@ -111906,11 +112065,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -112550,11 +112704,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113187,11 +113336,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -116362,11 +116506,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -119708,11 +119847,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -120201,11 +120335,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122669,6 +122798,10 @@ components: description: URL for the issue comment type: string format: uri + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" user: title: User type: @@ -123482,11 +123615,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -124685,11 +124813,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -125895,11 +126018,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -126365,182 +126483,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 + 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 - assignee: - "$ref": "#/components/schemas/webhooks_user" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - "$ref": "#/components/schemas/webhooks_issue" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - issue - - repository - - sender - webhook-issues-closed: - title: issues closed event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - closed + - pinned + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. + the comment belongs to. allOf: - title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127005,9 +126964,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - reminder - - pull_request_review_thread external_url: type: - string @@ -127191,7 +127147,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -127358,10 +127313,2578 @@ components: "$ref": "#/components/schemas/sub-issues-summary" issue_dependencies_summary: "$ref": "#/components/schemas/issue-dependencies-summary" - issue_field_values: - type: array - items: - "$ref": "#/components/schemas/issue-field-value" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-comment-unpinned: + title: issue_comment unpinned event + type: object + properties: + action: + type: string + enum: + - unpinned + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-dependencies-blocked-by-added: + title: blocked by issue added event + type: object + properties: + action: + type: string + enum: + - blocked_by_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocked-by-removed: + title: blocked by issue removed event + type: object + properties: + action: + type: string + enum: + - blocked_by_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocking-added: + title: blocking issue added event + type: object + properties: + action: + type: string + enum: + - blocking_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocking-removed: + title: blocking issue removed event + type: object + properties: + action: + type: string + enum: + - blocking_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issues-assigned: + title: issues assigned event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - assigned + assignee: + "$ref": "#/components/schemas/webhooks_user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - repository + - sender + webhook-issues-closed: + title: issues closed event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - closed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - security_and_analysis + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -128195,997 +130718,9 @@ components: format: uri user_view_type: type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - sub_issues_summary: - "$ref": "#/components/schemas/sub-issues-summary" - issue_dependencies_summary: - "$ref": "#/components/schemas/issue-dependencies-summary" - issue_field_values: - type: array - items: - "$ref": "#/components/schemas/issue-field-value" - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: - "$ref": "#/components/schemas/issue-type" - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - issue - - repository - - sender - webhook-issues-demilestoned: - title: issues demilestoned event - type: object - properties: - action: - type: string - enum: - - demilestoned - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - assignees: - type: array - items: - title: User - type: - - object - - 'null' - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: - - object - - 'null' - required: - - id - - node_id - - url - - name - - color - - default - - description - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They can be - installed directly on organizations and user accounts and granted - access to specific repositories. They come with granular permissions - and built-in webhooks. GitHub apps are first class actors within GitHub. - type: - - object - - 'null' - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -129280,7 +130815,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -129351,11 +130885,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129374,6 +130903,16 @@ components: - string - 'null' format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -129397,17 +130936,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -129430,6 +130958,17 @@ components: url: type: string format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket repository_url: type: string format: uri @@ -129471,9 +131010,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -129533,14 +131069,36 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri user_view_type: type: string - milestone: - "$ref": "#/components/schemas/webhooks_milestone" + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -129552,34 +131110,14 @@ components: - issue - repository - sender - webhook-issues-edited: - title: issues edited event + webhook-issues-demilestoned: + title: issues demilestoned event type: object properties: action: type: string enum: - - edited - changes: - description: The changes to the issue. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title. - type: string - required: - - from + - demilestoned enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -129589,6 +131127,28 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user properties: active_lock_reason: type: @@ -129605,6 +131165,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129667,11 +131230,6 @@ components: url: type: string format: uri - user_view_type: - type: string - required: - - login - - id assignees: type: array items: @@ -129679,6 +131237,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129741,9 +131302,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -129790,7 +131348,17 @@ components: type: array items: title: Label - type: object + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description properties: color: description: '6-character hex code, without the leading #, identifying @@ -129813,14 +131381,6 @@ components: description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string format: uri-template @@ -129832,6 +131392,23 @@ components: type: - object - 'null' + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at properties: closed_at: type: @@ -129848,6 +131425,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129912,9 +131492,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id description: type: - string @@ -129954,23 +131531,6 @@ components: url: type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at node_id: type: string number: @@ -129984,6 +131544,16 @@ components: type: - object - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: @@ -130045,9 +131615,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - pull_request_review_thread - - reminder external_url: type: - string @@ -130071,6 +131638,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -130134,9 +131704,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -130302,11 +131869,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130325,16 +131887,6 @@ components: - string - 'null' format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -130358,6 +131910,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -130380,17 +131943,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -130415,11 +131967,11 @@ components: timeline_url: type: string format: uri - type: - "$ref": "#/components/schemas/issue-type" title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -130432,6 +131984,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -130497,33 +132052,8 @@ components: format: uri user_view_type: type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - label: - "$ref": "#/components/schemas/webhooks_label" + milestone: + "$ref": "#/components/schemas/webhooks_milestone" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -130532,18 +132062,37 @@ components: "$ref": "#/components/schemas/simple-user" required: - action - - changes - issue - repository - sender - webhook-issues-labeled: - title: issues labeled event + webhook-issues-edited: + title: issues edited event type: object properties: action: type: string enum: - - labeled + - edited + changes: + description: The changes to the issue. + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + title: + type: object + properties: + from: + description: The previous version of the title. + type: string + required: + - from enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -131009,6 +132558,7 @@ components: - watch - workflow_dispatch - workflow_run + - security_and_analysis - pull_request_review_thread - reminder external_url: @@ -131265,11 +132815,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -131495,17 +133040,18 @@ components: "$ref": "#/components/schemas/simple-user" required: - action + - changes - issue - repository - sender - webhook-issues-locked: - title: issues locked event + webhook-issues-labeled: + title: issues labeled event type: object properties: action: type: string enum: - - locked + - labeled enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -131515,29 +133061,6 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - locked - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user properties: active_lock_reason: type: @@ -131554,9 +133077,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131615,11 +133135,15 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id assignees: type: array items: @@ -131627,9 +133151,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131688,11 +133209,13 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri - user_view_type: - type: string + required: + - login + - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -131739,17 +133262,7 @@ components: type: array items: title: Label - type: - - object - - 'null' - required: - - id - - node_id - - url - - name - - color - - default - - description + type: object properties: color: description: '6-character hex code, without the leading #, identifying @@ -131772,36 +133285,25 @@ components: description: URL for the label type: string format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description labels_url: type: string format: uri-template locked: type: boolean - enum: - - true milestone: title: Milestone description: A collection of related issues and pull requests. type: - object - 'null' - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at properties: closed_at: type: @@ -131818,9 +133320,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131879,11 +133378,15 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id description: type: - string @@ -131923,6 +133426,23 @@ components: url: type: string format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at node_id: type: string number: @@ -131936,16 +133456,6 @@ components: type: - object - 'null' - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at properties: created_at: type: @@ -132007,8 +133517,8 @@ components: - watch - workflow_dispatch - workflow_run + - pull_request_review_thread - reminder - - security_and_analysis external_url: type: - string @@ -132032,9 +133542,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -132098,6 +133605,9 @@ components: format: uri user_view_type: type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -132192,6 +133702,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -132262,11 +133773,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -132285,6 +133791,16 @@ components: - string - 'null' format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -132308,17 +133824,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -132341,6 +133846,17 @@ components: url: type: string format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket repository_url: type: string format: uri @@ -132382,9 +133898,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -132444,11 +133957,39 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + label: + "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -132460,14 +134001,14 @@ components: - issue - repository - sender - webhook-issues-milestoned: - title: issues milestoned event + webhook-issues-locked: + title: issues locked event type: object properties: action: type: string enum: - - milestoned + - locked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -132490,6 +134031,7 @@ components: - html_url - id - labels_url + - locked - milestone - node_id - number @@ -132579,6 +134121,8 @@ components: url: type: string format: uri + user_view_type: + type: string assignees: type: array items: @@ -132650,6 +134194,8 @@ components: url: type: string format: uri + user_view_type: + type: string author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -132734,6 +134280,8 @@ components: format: uri-template locked: type: boolean + enum: + - true milestone: title: Milestone description: A collection of related issues and pull requests. @@ -132834,7 +134382,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -132964,6 +134511,7 @@ components: - workflow_dispatch - workflow_run - reminder + - security_and_analysis external_url: type: - string @@ -133147,7 +134695,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -133218,7 +134765,953 @@ components: enum: - read - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + type: + "$ref": "#/components/schemas/issue-type" + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - repository + - sender + webhook-issues-milestoned: + title: issues milestoned event + type: object + properties: + action: + type: string + enum: + - milestoned + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + assignees: + type: array + items: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can be + installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within GitHub. + type: + - object + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -134146,11 +136639,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135545,11 +138033,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136562,11 +139045,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137486,11 +139964,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139048,11 +141521,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -217046,7 +219514,6 @@ components: - subject_type: installation subject_id: 954453 subject_name: GitHub Actions - integration_id: 124345 total_request_count: 544665 rate_limited_request_count: 13 last_request_timestamp: '2024-09-18T15:43:03Z' @@ -220101,7 +222568,7 @@ components: actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' - version_id: 2 actor: id: 2 @@ -220114,11 +222581,11 @@ components: updated_at: '2024-08-23T16:29:47Z' org-ruleset-version-with-state: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 21 name: super cool ruleset @@ -231937,11 +234404,11 @@ components: updated_at: '2023-08-23T16:29:47Z' repository-ruleset-version-with-state: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 42 name: super cool ruleset @@ -236531,7 +238998,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -236582,7 +239048,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -236826,7 +239291,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -236877,7 +239341,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -237109,7 +239572,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -237160,7 +239622,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -237417,7 +239878,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -237468,7 +239928,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 4d63e129a..acf3dc14f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -5782,14 +5782,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -6922,14 +6914,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -7835,14 +7819,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -8313,14 +8289,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -10649,14 +10617,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -11821,14 +11781,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -12857,14 +12809,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -13596,14 +13540,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -36498,6 +36434,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -68673,6 +68616,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -99171,7 +99121,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record": { "post": { "summary": "Create an artifact deployment record", - "description": "Create or update deployment records for an artifact associated with an organization.\nThis endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment.", + "description": "Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.", "tags": [ "orgs" ], @@ -99250,7 +99200,7 @@ }, "deployment_name": { "type": "string", - "description": "The name of the deployment." + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n" }, "tags": { "type": "object", @@ -107285,6 +107235,16 @@ ], "default": "disabled" }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, "code_scanning_options": { "type": [ "object", @@ -109087,6 +109047,15 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -116207,7 +116176,7 @@ }, "cli": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "description": "The organization policy for allowing or disallowing Copilot CLI.", "enum": [ "enabled", "disabled", @@ -131646,6 +131615,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -138136,7 +138112,6 @@ "subject_type": "installation", "subject_id": 954453, "subject_name": "GitHub Actions", - "integration_id": 124345, "total_request_count": 544665, "rate_limited_request_count": 13, "last_request_timestamp": "2024-09-18T15:43:03Z", @@ -139752,14 +139727,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -140907,14 +140874,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -209238,7 +209197,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209285,7 +209244,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209332,7 +209291,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209379,7 +209338,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209426,7 +209385,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210520,7 +210479,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210567,7 +210526,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210614,7 +210573,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210661,7 +210620,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210708,7 +210667,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211892,7 +211851,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211939,7 +211898,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211986,7 +211945,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -212033,7 +211992,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -212080,7 +212039,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -213922,7 +213881,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -213969,7 +213928,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214016,7 +213975,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214063,7 +214022,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214110,7 +214069,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215229,7 +215188,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215276,7 +215235,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215323,7 +215282,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215370,7 +215329,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215417,7 +215376,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216597,7 +216556,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216644,7 +216603,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216691,7 +216650,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216738,7 +216697,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216785,7 +216744,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -217413,7 +217372,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -217594,61 +217553,59 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -381159,6 +381116,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -400107,14 +400071,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -411565,6 +411521,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -412492,6 +412455,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -413357,6 +413327,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -438601,6 +438578,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -439502,6 +439486,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -494094,6 +494085,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -565786,7 +565784,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -565859,7 +565857,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -565932,7 +565930,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -566005,7 +566003,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -566078,7 +566076,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567531,7 +567529,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567578,7 +567576,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567625,7 +567623,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567672,7 +567670,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567719,7 +567717,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568680,7 +568678,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568727,7 +568725,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568774,7 +568772,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568821,7 +568819,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568868,7 +568866,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570042,7 +570040,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570089,7 +570087,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570136,7 +570134,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570183,7 +570181,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570230,7 +570228,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572091,7 +572089,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572138,7 +572136,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572185,7 +572183,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572232,7 +572230,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572279,7 +572277,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573255,7 +573253,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573302,7 +573300,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573349,7 +573347,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573396,7 +573394,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573443,7 +573441,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574613,7 +574611,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574660,7 +574658,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574707,7 +574705,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574754,7 +574752,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574801,7 +574799,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -575437,7 +575435,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -575627,51 +575625,49 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -655661,14 +655657,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -709212,6 +709200,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -720131,6 +720126,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -731060,6 +731062,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -736693,14 +736702,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -768669,6 +768670,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -779584,6 +779592,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -803735,7 +803750,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -803790,7 +803804,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -808699,7 +808712,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -808754,7 +808766,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -813661,7 +813672,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -813716,7 +813726,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -818640,7 +818649,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -818695,7 +818703,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -819418,13 +819425,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -822217,13 +822217,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -825009,13 +825002,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -879296,13 +879282,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -899243,666 +899222,652 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "production_environment": { - "type": "boolean" - }, - "ref": { - "type": "string" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "task": { - "type": "string" - }, - "transient_environment": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "sha", - "ref", - "task", - "payload", - "original_environment", - "environment", - "description", - "creator", - "created_at", - "updated_at", - "statuses_url", - "repository_url" - ] - }, - "deployment_status": { - "description": "The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses).", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "description": { - "description": "The optional human-readable description added to the status.", - "type": "string" - }, - "environment": { - "type": "string" - }, - "environment_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "log_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "pull_request_review_thread", - "merge_queue_entry", - "workflow_job", - "merge_group", - "secret_scanning_alert_location" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "production_environment": { + "type": "boolean" + }, + "ref": { + "type": "string" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "task": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", + "created_at", + "updated_at", + "statuses_url", + "repository_url" + ] + }, + "deployment_status": { + "description": "The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "deployment_url": { + "type": "string", + "format": "uri" + }, + "description": { + "description": "The optional human-readable description added to the status.", + "type": "string" + }, + "environment": { + "type": "string" + }, + "environment_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "log_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job", + "merge_group", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { "type": "string", "enum": [ "read", @@ -956562,14 +956527,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -959677,14 +959634,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -962697,14 +962646,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -965717,14 +965658,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -968871,14 +968804,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -972032,14 +971957,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -977188,14 +977105,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -979470,411 +979379,9047 @@ "type": "string" }, "performed_via_github_app": { - "anyOf": [ - { - "type": "null" + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the comment.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "issues": { - "type": "string" + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "checks": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "metadata": { - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "contents": { - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "deployments": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 ] } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, "reactions": { @@ -980019,7 +988564,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -980034,6 +988580,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -981085,8 +989638,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "secret_scanning_alerts": { @@ -981131,13 +989683,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -983635,6 +992180,7 @@ }, "required": [ "action", + "changes", "issue", "comment", "repository", @@ -983661,11 +992207,11 @@ } } }, - "issue-comment-deleted": { + "issue-comment-pinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" }, @@ -983732,13 +992278,13 @@ "content": { "application/json": { "schema": { - "title": "issue_comment deleted event", + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "pinned" ] }, "comment": { @@ -984344,6 +992890,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -987970,11 +996523,11 @@ } } }, - "issue-comment-edited": { + "issue-comment-unpinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" }, @@ -988041,33 +996594,15 @@ "content": { "application/json": { "schema": { - "title": "issue_comment edited event", + "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "unpinned" ] }, - "changes": { - "description": "The changes to the comment.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "comment": { "title": "issue comment", "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", @@ -988671,6 +997206,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -989408,9 +997950,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -989665,8 +998205,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -990499,6 +999038,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -992271,7 +1000813,6 @@ }, "required": [ "action", - "changes", "issue", "comment", "repository", @@ -1028275,13 +1036816,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1031724,13 +1040258,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1035381,13 +1043908,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1038853,13 +1047373,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1042484,13 +1050997,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1045969,13 +1054475,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1049493,13 +1057992,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1052930,13 +1061422,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1056418,13 +1064903,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1058610,13 +1067088,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1062047,13 +1070518,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1065522,13 +1073986,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1068814,13 +1077271,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1071022,13 +1079472,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1074466,13 +1082909,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1078079,13 +1086515,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1081523,13 +1089952,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1085045,13 +1093467,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1088448,13 +1096863,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1091891,13 +1100299,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1431402,7 +1439803,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431449,7 +1439850,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431496,7 +1439897,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431543,7 +1439944,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431590,7 +1439991,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434702,7 +1443103,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434749,7 +1443150,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434796,7 +1443197,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434843,7 +1443244,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434890,7 +1443291,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438002,7 +1446403,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438049,7 +1446450,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438096,7 +1446497,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438143,7 +1446544,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438190,7 +1446591,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439076,7 +1447477,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439123,7 +1447524,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439170,7 +1447571,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439217,7 +1447618,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439264,7 +1447665,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439978,7 +1448379,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440025,7 +1448426,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440072,7 +1448473,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440119,7 +1448520,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440166,7 +1448567,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440883,7 +1449284,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440930,7 +1449331,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440977,7 +1449378,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1441024,7 +1449425,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1441071,7 +1449472,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1446005,6 +1454406,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } @@ -1450317,6 +1458719,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 24978b8c9..7ed2afe62 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -2656,13 +2656,6 @@ paths: enum: - read - write - team_discussions: - type: string - description: The level of permission to grant the access - token to manage team discussions and related comments. - enum: - - read - - write email_addresses: type: string description: The level of permission to grant the access @@ -11963,6 +11956,9 @@ paths: - type: 'null' - *5 reactions: *73 + pin: + anyOf: + - type: 'null' required: - id - node_id @@ -25100,8 +25096,19 @@ paths: post: summary: Create an artifact deployment record description: |- - Create or update deployment records for an artifact associated with an organization. - This endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment. + Create or update deployment records for an artifact associated + with an organization. + This endpoint allows you to record information about a specific + artifact, such as its name, digest, environments, cluster, and + deployment. + The deployment name has to be uniqe within a cluster (i.e a + combination of logical, physical environment and cluster) as it + identifies unique deployment. + Multiple requests for the same combination of logical, physical + environment, cluster and deployment name will only create one + record, successive request will update the existing record. + This allows for a stable tracking of a deployment where the actual + deployed artifact can change over time. tags: - orgs operationId: orgs/create-artifact-deployment-record @@ -25160,7 +25167,10 @@ paths: description: The deployment cluster. deployment_name: type: string - description: The name of the deployment. + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a cluster, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. tags: type: object description: The tags associated with the deployment. @@ -27891,6 +27901,15 @@ paths: - disabled - not_set default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled code_scanning_options: *49 code_scanning_default_setup: type: string @@ -28248,6 +28267,14 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -30136,7 +30163,7 @@ paths: cli: type: string description: The organization policy for allowing or disallowing - Copilot in the CLI. + Copilot CLI. enum: - enabled - disabled @@ -32888,7 +32915,6 @@ paths: - subject_type: installation subject_id: 954453 subject_name: GitHub Actions - integration_id: 124345 total_request_count: 544665 rate_limited_request_count: 13 last_request_timestamp: '2024-09-18T15:43:03Z' @@ -43943,7 +43969,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -43979,7 +44006,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44015,7 +44043,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44051,7 +44080,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44087,7 +44117,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -45075,7 +45106,7 @@ paths: actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' - version_id: 2 actor: id: 2 @@ -45135,11 +45166,11 @@ paths: examples: default: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 21 name: super cool ruleset @@ -82017,6 +82048,9 @@ paths: - type: 'null' - *5 reactions: *73 + pin: + anyOf: + - type: 'null' required: - event - actor @@ -91573,11 +91607,11 @@ paths: examples: default: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 42 name: super cool ruleset @@ -110486,7 +110520,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -110537,7 +110570,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -110883,7 +110915,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -110934,7 +110965,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -111280,7 +111310,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -111331,7 +111360,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -111692,7 +111720,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -111743,7 +111770,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -112315,11 +112341,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113029,11 +113050,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113736,11 +113752,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -118434,11 +118445,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122319,502 +122325,492 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - deployment_status: - description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). - type: object - properties: - created_at: - type: string - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - deployment_url: - type: string - format: uri - description: - description: The optional human-readable description added to - the status. - type: string - environment: - type: string - environment_url: - type: string - format: uri - id: - type: integer - log_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - merge_queue_entry - - workflow_job - - merge_group - - secret_scanning_alert_location - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + production_environment: + type: boolean + ref: + type: string + repository_url: + type: string + format: uri + sha: + type: string + statuses_url: + type: string + format: uri + task: + type: string + transient_environment: + type: boolean + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - id + - node_id + - sha + - ref + - task + - payload + - original_environment + - environment + - description + - creator + - created_at + - updated_at + - statuses_url + - repository_url + deployment_status: + description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + deployment_url: + type: string + format: uri + description: + description: The optional human-readable description added to + the status. + type: string + environment: + type: string + environment_url: + type: string + format: uri + id: + type: integer + log_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps are + first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - pull_request_review_thread + - merge_queue_entry + - workflow_job + - merge_group + - secret_scanning_alert_location + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -127447,6 +127443,9 @@ webhooks: description: URL for the issue comment type: string format: uri + pin: + anyOf: + - type: 'null' user: title: User type: @@ -128258,7 +128257,2694 @@ webhooks: enum: - read - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: *626 + issue_dependencies_summary: *627 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *215 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - labels + - state + - locked + - assignee + organization: *693 + repository: *694 + sender: *4 + required: + - action + - issue + - comment + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue_comment + supported-webhook-types: + - repository + - organization + - app + issue-comment-deleted: + post: + summary: |- + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. + + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was deleted. + operationId: issue-comment/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issue_comment deleted event + type: object + properties: + action: + type: string + enum: + - deleted + comment: &715 + title: issue comment + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) + itself. + type: object + properties: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue comment + type: string + created_at: + type: string + format: date-time + html_url: + type: string + format: uri + id: + description: Unique identifier of the issue comment + type: integer + format: int64 + issue_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: *5 + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + updated_at: + type: string + format: date-time + url: + description: URL for the issue comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + pin: + anyOf: + - type: 'null' + required: + - url + - html_url + - issue_url + - id + - node_id + - user + - created_at + - updated_at + - author_association + - performed_via_github_app + - body + - reactions + enterprise: *691 + installation: *692 + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: *626 + issue_dependencies_summary: *627 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *215 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: *693 + repository: *694 + sender: *4 + required: + - action + - issue + - comment + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue_comment + supported-webhook-types: + - repository + - organization + - app + issue-comment-edited: + post: + summary: |- + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. + + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was edited. + operationId: issue-comment/edited + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issue_comment edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: &739 + description: The changes to the comment. + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + comment: *715 + enterprise: *691 + installation: *692 + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -128717,6 +131403,7 @@ webhooks: sender: *4 required: - action + - changes - issue - comment - repository @@ -128733,7 +131420,7 @@ webhooks: - repository - organization - app - issue-comment-deleted: + issue-comment-pinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. @@ -128741,8 +131428,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was deleted. - operationId: issue-comment/deleted + description: A comment on an issue was pinned. + operationId: issue-comment/pinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -128786,180 +131473,14 @@ webhooks: content: application/json: schema: - title: issue_comment deleted event + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted - comment: &715 - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: *5 - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: - type: string - format: date-time - url: - description: URL for the issue comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - html_url - - issue_url - - id - - node_id - - user - - created_at - - updated_at - - author_association - - performed_via_github_app - - body - - reactions + - pinned + comment: *715 enterprise: *691 installation: *692 issue: @@ -130159,7 +132680,7 @@ webhooks: - repository - organization - app - issue-comment-edited: + issue-comment-unpinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. @@ -130167,8 +132688,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was edited. - operationId: issue-comment/edited + description: A comment on an issue was unpinned. + operationId: issue-comment/unpinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -130212,25 +132733,13 @@ webhooks: content: application/json: schema: - title: issue_comment edited event + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: &739 - description: The changes to the comment. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from + - unpinned comment: *715 enterprise: *691 installation: *692 @@ -130701,8 +133210,6 @@ webhooks: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: - string @@ -130886,7 +133393,6 @@ webhooks: enum: - read - write - - admin organization_secrets: type: string enum: @@ -131406,6 +133912,8 @@ webhooks: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -131416,7 +133924,6 @@ webhooks: sender: *4 required: - action - - changes - issue - comment - repository @@ -132579,11 +135086,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -133602,11 +136104,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -134758,11 +137255,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135803,11 +138295,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136951,11 +139438,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137969,11 +140451,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139022,11 +141499,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -140034,11 +142506,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -141019,11 +143486,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -142413,11 +144875,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -143425,11 +145882,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -144473,11 +146925,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -145455,11 +147902,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -147313,11 +149755,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -221730,6 +224167,7 @@ webhooks: state: type: string enum: + - auto_dismissed - open enterprise: *691 installation: *692 diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 4d63e129a..acf3dc14f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -5782,14 +5782,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -6922,14 +6914,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -7835,14 +7819,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -8313,14 +8289,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -10649,14 +10617,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -11821,14 +11781,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -12857,14 +12809,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -13596,14 +13540,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -36498,6 +36434,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -68673,6 +68616,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -99171,7 +99121,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record": { "post": { "summary": "Create an artifact deployment record", - "description": "Create or update deployment records for an artifact associated with an organization.\nThis endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment.", + "description": "Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.", "tags": [ "orgs" ], @@ -99250,7 +99200,7 @@ }, "deployment_name": { "type": "string", - "description": "The name of the deployment." + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n" }, "tags": { "type": "object", @@ -107285,6 +107235,16 @@ ], "default": "disabled" }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, "code_scanning_options": { "type": [ "object", @@ -109087,6 +109047,15 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -116207,7 +116176,7 @@ }, "cli": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "description": "The organization policy for allowing or disallowing Copilot CLI.", "enum": [ "enabled", "disabled", @@ -131646,6 +131615,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -138136,7 +138112,6 @@ "subject_type": "installation", "subject_id": 954453, "subject_name": "GitHub Actions", - "integration_id": 124345, "total_request_count": 544665, "rate_limited_request_count": 13, "last_request_timestamp": "2024-09-18T15:43:03Z", @@ -139752,14 +139727,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -140907,14 +140874,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -209238,7 +209197,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209285,7 +209244,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209332,7 +209291,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209379,7 +209338,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209426,7 +209385,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210520,7 +210479,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210567,7 +210526,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210614,7 +210573,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210661,7 +210620,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210708,7 +210667,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211892,7 +211851,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211939,7 +211898,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211986,7 +211945,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -212033,7 +211992,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -212080,7 +212039,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -213922,7 +213881,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -213969,7 +213928,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214016,7 +213975,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214063,7 +214022,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214110,7 +214069,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215229,7 +215188,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215276,7 +215235,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215323,7 +215282,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215370,7 +215329,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215417,7 +215376,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216597,7 +216556,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216644,7 +216603,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216691,7 +216650,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216738,7 +216697,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216785,7 +216744,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -217413,7 +217372,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -217594,61 +217553,59 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -381159,6 +381116,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -400107,14 +400071,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -411565,6 +411521,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -412492,6 +412455,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -413357,6 +413327,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -438601,6 +438578,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -439502,6 +439486,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -494094,6 +494085,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -565786,7 +565784,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -565859,7 +565857,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -565932,7 +565930,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -566005,7 +566003,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -566078,7 +566076,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567531,7 +567529,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567578,7 +567576,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567625,7 +567623,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567672,7 +567670,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567719,7 +567717,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568680,7 +568678,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568727,7 +568725,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568774,7 +568772,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568821,7 +568819,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568868,7 +568866,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570042,7 +570040,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570089,7 +570087,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570136,7 +570134,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570183,7 +570181,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570230,7 +570228,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572091,7 +572089,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572138,7 +572136,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572185,7 +572183,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572232,7 +572230,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572279,7 +572277,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573255,7 +573253,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573302,7 +573300,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573349,7 +573347,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573396,7 +573394,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573443,7 +573441,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574613,7 +574611,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574660,7 +574658,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574707,7 +574705,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574754,7 +574752,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574801,7 +574799,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -575437,7 +575435,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -575627,51 +575625,49 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -655661,14 +655657,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -709212,6 +709200,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -720131,6 +720126,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -731060,6 +731062,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -736693,14 +736702,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -768669,6 +768670,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -779584,6 +779592,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -803735,7 +803750,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -803790,7 +803804,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -808699,7 +808712,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -808754,7 +808766,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -813661,7 +813672,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -813716,7 +813726,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -818640,7 +818649,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -818695,7 +818703,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -819418,13 +819425,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -822217,13 +822217,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -825009,13 +825002,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -879296,13 +879282,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -899243,666 +899222,652 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "production_environment": { - "type": "boolean" - }, - "ref": { - "type": "string" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "task": { - "type": "string" - }, - "transient_environment": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "sha", - "ref", - "task", - "payload", - "original_environment", - "environment", - "description", - "creator", - "created_at", - "updated_at", - "statuses_url", - "repository_url" - ] - }, - "deployment_status": { - "description": "The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses).", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "description": { - "description": "The optional human-readable description added to the status.", - "type": "string" - }, - "environment": { - "type": "string" - }, - "environment_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "log_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "pull_request_review_thread", - "merge_queue_entry", - "workflow_job", - "merge_group", - "secret_scanning_alert_location" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "production_environment": { + "type": "boolean" + }, + "ref": { + "type": "string" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "task": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", + "created_at", + "updated_at", + "statuses_url", + "repository_url" + ] + }, + "deployment_status": { + "description": "The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "deployment_url": { + "type": "string", + "format": "uri" + }, + "description": { + "description": "The optional human-readable description added to the status.", + "type": "string" + }, + "environment": { + "type": "string" + }, + "environment_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "log_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job", + "merge_group", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { "type": "string", "enum": [ "read", @@ -956562,14 +956527,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -959677,14 +959634,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -962697,14 +962646,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -965717,14 +965658,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -968871,14 +968804,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -972032,14 +971957,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -977188,14 +977105,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -979470,411 +979379,9047 @@ "type": "string" }, "performed_via_github_app": { - "anyOf": [ - { - "type": "null" + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the comment.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "issues": { - "type": "string" + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "checks": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "metadata": { - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "contents": { - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "deployments": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 ] } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, "reactions": { @@ -980019,7 +988564,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -980034,6 +988580,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -981085,8 +989638,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "secret_scanning_alerts": { @@ -981131,13 +989683,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -983635,6 +992180,7 @@ }, "required": [ "action", + "changes", "issue", "comment", "repository", @@ -983661,11 +992207,11 @@ } } }, - "issue-comment-deleted": { + "issue-comment-pinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" }, @@ -983732,13 +992278,13 @@ "content": { "application/json": { "schema": { - "title": "issue_comment deleted event", + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "pinned" ] }, "comment": { @@ -984344,6 +992890,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -987970,11 +996523,11 @@ } } }, - "issue-comment-edited": { + "issue-comment-unpinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" }, @@ -988041,33 +996594,15 @@ "content": { "application/json": { "schema": { - "title": "issue_comment edited event", + "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "unpinned" ] }, - "changes": { - "description": "The changes to the comment.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "comment": { "title": "issue comment", "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", @@ -988671,6 +997206,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -989408,9 +997950,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -989665,8 +998205,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -990499,6 +999038,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -992271,7 +1000813,6 @@ }, "required": [ "action", - "changes", "issue", "comment", "repository", @@ -1028275,13 +1036816,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1031724,13 +1040258,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1035381,13 +1043908,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1038853,13 +1047373,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1042484,13 +1050997,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1045969,13 +1054475,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1049493,13 +1057992,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1052930,13 +1061422,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1056418,13 +1064903,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1058610,13 +1067088,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1062047,13 +1070518,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1065522,13 +1073986,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1068814,13 +1077271,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1071022,13 +1079472,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1074466,13 +1082909,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1078079,13 +1086515,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1081523,13 +1089952,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1085045,13 +1093467,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1088448,13 +1096863,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1091891,13 +1100299,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1431402,7 +1439803,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431449,7 +1439850,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431496,7 +1439897,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431543,7 +1439944,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431590,7 +1439991,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434702,7 +1443103,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434749,7 +1443150,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434796,7 +1443197,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434843,7 +1443244,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434890,7 +1443291,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438002,7 +1446403,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438049,7 +1446450,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438096,7 +1446497,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438143,7 +1446544,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438190,7 +1446591,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439076,7 +1447477,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439123,7 +1447524,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439170,7 +1447571,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439217,7 +1447618,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439264,7 +1447665,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439978,7 +1448379,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440025,7 +1448426,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440072,7 +1448473,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440119,7 +1448520,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440166,7 +1448567,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440883,7 +1449284,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440930,7 +1449331,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440977,7 +1449378,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1441024,7 +1449425,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1441071,7 +1449472,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1446005,6 +1454406,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } @@ -1450317,6 +1458719,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 24978b8c9..7ed2afe62 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -2656,13 +2656,6 @@ paths: enum: - read - write - team_discussions: - type: string - description: The level of permission to grant the access - token to manage team discussions and related comments. - enum: - - read - - write email_addresses: type: string description: The level of permission to grant the access @@ -11963,6 +11956,9 @@ paths: - type: 'null' - *5 reactions: *73 + pin: + anyOf: + - type: 'null' required: - id - node_id @@ -25100,8 +25096,19 @@ paths: post: summary: Create an artifact deployment record description: |- - Create or update deployment records for an artifact associated with an organization. - This endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment. + Create or update deployment records for an artifact associated + with an organization. + This endpoint allows you to record information about a specific + artifact, such as its name, digest, environments, cluster, and + deployment. + The deployment name has to be uniqe within a cluster (i.e a + combination of logical, physical environment and cluster) as it + identifies unique deployment. + Multiple requests for the same combination of logical, physical + environment, cluster and deployment name will only create one + record, successive request will update the existing record. + This allows for a stable tracking of a deployment where the actual + deployed artifact can change over time. tags: - orgs operationId: orgs/create-artifact-deployment-record @@ -25160,7 +25167,10 @@ paths: description: The deployment cluster. deployment_name: type: string - description: The name of the deployment. + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a cluster, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. tags: type: object description: The tags associated with the deployment. @@ -27891,6 +27901,15 @@ paths: - disabled - not_set default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled code_scanning_options: *49 code_scanning_default_setup: type: string @@ -28248,6 +28267,14 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -30136,7 +30163,7 @@ paths: cli: type: string description: The organization policy for allowing or disallowing - Copilot in the CLI. + Copilot CLI. enum: - enabled - disabled @@ -32888,7 +32915,6 @@ paths: - subject_type: installation subject_id: 954453 subject_name: GitHub Actions - integration_id: 124345 total_request_count: 544665 rate_limited_request_count: 13 last_request_timestamp: '2024-09-18T15:43:03Z' @@ -43943,7 +43969,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -43979,7 +44006,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44015,7 +44043,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44051,7 +44080,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44087,7 +44117,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -45075,7 +45106,7 @@ paths: actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' - version_id: 2 actor: id: 2 @@ -45135,11 +45166,11 @@ paths: examples: default: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 21 name: super cool ruleset @@ -82017,6 +82048,9 @@ paths: - type: 'null' - *5 reactions: *73 + pin: + anyOf: + - type: 'null' required: - event - actor @@ -91573,11 +91607,11 @@ paths: examples: default: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 42 name: super cool ruleset @@ -110486,7 +110520,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -110537,7 +110570,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -110883,7 +110915,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -110934,7 +110965,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -111280,7 +111310,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -111331,7 +111360,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -111692,7 +111720,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -111743,7 +111770,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -112315,11 +112341,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113029,11 +113050,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113736,11 +113752,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -118434,11 +118445,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122319,502 +122325,492 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - deployment_status: - description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). - type: object - properties: - created_at: - type: string - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - deployment_url: - type: string - format: uri - description: - description: The optional human-readable description added to - the status. - type: string - environment: - type: string - environment_url: - type: string - format: uri - id: - type: integer - log_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - merge_queue_entry - - workflow_job - - merge_group - - secret_scanning_alert_location - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + production_environment: + type: boolean + ref: + type: string + repository_url: + type: string + format: uri + sha: + type: string + statuses_url: + type: string + format: uri + task: + type: string + transient_environment: + type: boolean + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - id + - node_id + - sha + - ref + - task + - payload + - original_environment + - environment + - description + - creator + - created_at + - updated_at + - statuses_url + - repository_url + deployment_status: + description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + deployment_url: + type: string + format: uri + description: + description: The optional human-readable description added to + the status. + type: string + environment: + type: string + environment_url: + type: string + format: uri + id: + type: integer + log_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps are + first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - pull_request_review_thread + - merge_queue_entry + - workflow_job + - merge_group + - secret_scanning_alert_location + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -127447,6 +127443,9 @@ webhooks: description: URL for the issue comment type: string format: uri + pin: + anyOf: + - type: 'null' user: title: User type: @@ -128258,7 +128257,2694 @@ webhooks: enum: - read - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: *626 + issue_dependencies_summary: *627 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *215 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - labels + - state + - locked + - assignee + organization: *693 + repository: *694 + sender: *4 + required: + - action + - issue + - comment + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue_comment + supported-webhook-types: + - repository + - organization + - app + issue-comment-deleted: + post: + summary: |- + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. + + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was deleted. + operationId: issue-comment/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issue_comment deleted event + type: object + properties: + action: + type: string + enum: + - deleted + comment: &715 + title: issue comment + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) + itself. + type: object + properties: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue comment + type: string + created_at: + type: string + format: date-time + html_url: + type: string + format: uri + id: + description: Unique identifier of the issue comment + type: integer + format: int64 + issue_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: *5 + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + updated_at: + type: string + format: date-time + url: + description: URL for the issue comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + pin: + anyOf: + - type: 'null' + required: + - url + - html_url + - issue_url + - id + - node_id + - user + - created_at + - updated_at + - author_association + - performed_via_github_app + - body + - reactions + enterprise: *691 + installation: *692 + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: *626 + issue_dependencies_summary: *627 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *215 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: *693 + repository: *694 + sender: *4 + required: + - action + - issue + - comment + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue_comment + supported-webhook-types: + - repository + - organization + - app + issue-comment-edited: + post: + summary: |- + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. + + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was edited. + operationId: issue-comment/edited + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issue_comment edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: &739 + description: The changes to the comment. + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + comment: *715 + enterprise: *691 + installation: *692 + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -128717,6 +131403,7 @@ webhooks: sender: *4 required: - action + - changes - issue - comment - repository @@ -128733,7 +131420,7 @@ webhooks: - repository - organization - app - issue-comment-deleted: + issue-comment-pinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. @@ -128741,8 +131428,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was deleted. - operationId: issue-comment/deleted + description: A comment on an issue was pinned. + operationId: issue-comment/pinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -128786,180 +131473,14 @@ webhooks: content: application/json: schema: - title: issue_comment deleted event + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted - comment: &715 - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: *5 - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: - type: string - format: date-time - url: - description: URL for the issue comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - html_url - - issue_url - - id - - node_id - - user - - created_at - - updated_at - - author_association - - performed_via_github_app - - body - - reactions + - pinned + comment: *715 enterprise: *691 installation: *692 issue: @@ -130159,7 +132680,7 @@ webhooks: - repository - organization - app - issue-comment-edited: + issue-comment-unpinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. @@ -130167,8 +132688,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was edited. - operationId: issue-comment/edited + description: A comment on an issue was unpinned. + operationId: issue-comment/unpinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -130212,25 +132733,13 @@ webhooks: content: application/json: schema: - title: issue_comment edited event + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: &739 - description: The changes to the comment. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from + - unpinned comment: *715 enterprise: *691 installation: *692 @@ -130701,8 +133210,6 @@ webhooks: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: - string @@ -130886,7 +133393,6 @@ webhooks: enum: - read - write - - admin organization_secrets: type: string enum: @@ -131406,6 +133912,8 @@ webhooks: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -131416,7 +133924,6 @@ webhooks: sender: *4 required: - action - - changes - issue - comment - repository @@ -132579,11 +135086,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -133602,11 +136104,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -134758,11 +137255,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135803,11 +138295,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136951,11 +139438,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137969,11 +140451,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139022,11 +141499,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -140034,11 +142506,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -141019,11 +143486,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -142413,11 +144875,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -143425,11 +145882,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -144473,11 +146925,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -145455,11 +147902,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -147313,11 +149755,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -221730,6 +224167,7 @@ webhooks: state: type: string enum: + - auto_dismissed - open enterprise: *691 installation: *692 diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 93e1fdf2a..69cf37ef4 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -5798,14 +5798,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -6954,14 +6946,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -7883,14 +7867,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -8377,14 +8353,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -10729,14 +10697,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -11917,14 +11877,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -12969,14 +12921,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -13724,14 +13668,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -31288,14 +31224,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -32175,9 +32103,1100 @@ "write" ] }, - "team_discussions": { + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "enterprise_organization_installations": { + "type": "string", + "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_organization_installation_repositories": { "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "description": "The level of permission to grant the access token to manage repository access of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "repository_selection": "selected", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + } + } + } + } + }, + "201": { + "description": "A GitHub App installation.", + "content": { + "application/json": { + "schema": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" @@ -32584,9 +33603,406 @@ } } } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "client_id": { + "type": "string", + "description": "The Client ID of the GitHub App to install." + }, + "repository_selection": { + "type": "string", + "description": "The repository selection for the GitHub App. Must be one of:\n* `all` - the installation can access all repositories in the organization.\n* `selected` - the installation can access only the listed repositories.\n* `none` - no repository permissions are requested. Only use when the app does not request repository permissions.", + "enum": [ + "all", + "selected", + "none" + ] + }, + "repositories": { + "type": "array", + "description": "The names of the repositories to which the installation will be granted access. This is the simple name of the repository, not the full name (e.g., `hello-world` not `octocat/hello-world`). This is only required when `repository_selection` is `selected`.", + "items": { + "type": "string" + }, + "maxItems": 50 + } + }, + "required": [ + "client_id", + "repository_selection" + ] + }, + "examples": { + "default": { + "summary": "Example of installing a GitHub App on an organization and granting access to all of its repositories.", + "value": { + "client_id": "Iv2abc123aabbcc", + "repository_selection": "all" + } + }, + "repository_selection_selected": { + "value": { + "client_id": "Iv2abc123aabbcc", + "repository_selection": "selected", + "repositories": [ + "hello-world", + "hello-world-2" + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "organization-installations" + } + } + }, + "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}": { + "delete": { + "summary": "Uninstall a GitHub App from an enterprise-owned organization", + "description": "Uninstall a GitHub App from an organization. Any app installed on the organization can be removed.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", + "tags": [ + "apps" + ], + "operationId": "enterprise-apps/delete-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "201": { - "description": "A GitHub App installation.", + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + } + ], + "responses": { + "204": { + "description": "An empty response indicates that the installation was successfully removed." + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "organization-installations" + } + } + }, + "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories": { + "get": { + "summary": "Get the repositories accessible to a given GitHub App installation", + "description": "Lists the repositories accessible to a given GitHub App installation on an enterprise-owned organization.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", + "tags": [ + "apps" + ], + "operationId": "enterprise-apps/organization-installation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "A list of repositories owned by the enterprise organization to which the installation has access.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Accessible Repository", + "description": "A repository that may be made accessible to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + } + }, + "required": [ + "full_name", + "id", + "name" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "name": "Hello World", + "full_name": "octocat/Hello-World" + }, + { + "id": 2, + "login": "Goodbye World", + "full_name": "octocat/Goodbye-World" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "organization-installations" + } + }, + "patch": { + "summary": "Toggle installation repository access between selected and all repositories", + "description": "Toggle repository access for a GitHub App installation between all repositories and selected repositories. You must provide at least one repository when changing the access to 'selected'. If you change the access to 'all', the repositories list must not be provided.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", + "tags": [ + "apps" + ], + "operationId": "enterprise-apps/change-installation-repository-access-selection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_selection": { + "type": "string", + "description": "One of either 'all' or 'selected'", + "enum": [ + "all", + "selected" + ] + }, + "repositories": { + "type": "array", + "description": "The repository names to add to the installation. Only required when repository_selection is 'selected'", + "items": { + "type": "string" + }, + "maxItems": 50 + } + }, + "required": [ + "repository_selection" + ] + }, + "examples": { + "default": { + "summary": "Change the repositories accessible to a GitHub App from 'all repositories' to a specified subset.", + "value": { + "repository_selection": "selected", + "repositories": [ + "hello-world", + "hello-world-2" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "The GitHub App installation that was updated.", "content": { "application/json": { "schema": { @@ -33282,1518 +34698,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - }, - "enterprise_custom_properties_for_organizations": { - "type": "string", - "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "enterprise_organization_installations": { - "type": "string", - "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", - "enum": [ - "read", - "write" - ] - }, - "enterprise_organization_installation_repositories": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository access of GitHub Apps on Enterprise-owned organizations.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" - ] - } - }, - "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "account": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/organizations/github/settings/installations/1", - "app_id": 1, - "target_id": 1, - "target_type": "Organization", - "permissions": { - "checks": "write", - "metadata": "read", - "contents": "read" - }, - "events": [ - "push", - "pull_request" - ], - "single_file_name": "config.yaml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "repository_selection": "selected", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - } - } - } - } - } - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_id": { - "type": "string", - "description": "The Client ID of the GitHub App to install." - }, - "repository_selection": { - "type": "string", - "description": "The repository selection for the GitHub App. Must be one of:\n* `all` - the installation can access all repositories in the organization.\n* `selected` - the installation can access only the listed repositories.\n* `none` - no repository permissions are requested. Only use when the app does not request repository permissions.", - "enum": [ - "all", - "selected", - "none" - ] - }, - "repositories": { - "type": "array", - "description": "The names of the repositories to which the installation will be granted access. This is the simple name of the repository, not the full name (e.g., `hello-world` not `octocat/hello-world`). This is only required when `repository_selection` is `selected`.", - "items": { - "type": "string" - }, - "maxItems": 50 - } - }, - "required": [ - "client_id", - "repository_selection" - ] - }, - "examples": { - "default": { - "summary": "Example of installing a GitHub App on an organization and granting access to all of its repositories.", - "value": { - "client_id": "Iv2abc123aabbcc", - "repository_selection": "all" - } - }, - "repository_selection_selected": { - "value": { - "client_id": "Iv2abc123aabbcc", - "repository_selection": "selected", - "repositories": [ - "hello-world", - "hello-world-2" - ] - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "organization-installations" - } - } - }, - "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}": { - "delete": { - "summary": "Uninstall a GitHub App from an enterprise-owned organization", - "description": "Uninstall a GitHub App from an organization. Any app installed on the organization can be removed.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", - "tags": [ - "apps" - ], - "operationId": "enterprise-apps/delete-installation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "examples": { - "default": { - "value": 1 - } - } - } - ], - "responses": { - "204": { - "description": "An empty response indicates that the installation was successfully removed." - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "organization-installations" - } - } - }, - "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories": { - "get": { - "summary": "Get the repositories accessible to a given GitHub App installation", - "description": "Lists the repositories accessible to a given GitHub App installation on an enterprise-owned organization.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", - "tags": [ - "apps" - ], - "operationId": "enterprise-apps/organization-installation-repositories", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "examples": { - "default": { - "value": 1 - } - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "A list of repositories owned by the enterprise organization to which the installation has access.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Accessible Repository", - "description": "A repository that may be made accessible to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - } - }, - "required": [ - "full_name", - "id", - "name" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "name": "Hello World", - "full_name": "octocat/Hello-World" - }, - { - "id": 2, - "login": "Goodbye World", - "full_name": "octocat/Goodbye-World" - } - ] - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "organization-installations" - } - }, - "patch": { - "summary": "Toggle installation repository access between selected and all repositories", - "description": "Toggle repository access for a GitHub App installation between all repositories and selected repositories. You must provide at least one repository when changing the access to 'selected'. If you change the access to 'all', the repositories list must not be provided.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", - "tags": [ - "apps" - ], - "operationId": "enterprise-apps/change-installation-repository-access-selection", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "examples": { - "default": { - "value": 1 - } - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repository_selection": { - "type": "string", - "description": "One of either 'all' or 'selected'", - "enum": [ - "all", - "selected" - ] - }, - "repositories": { - "type": "array", - "description": "The repository names to add to the installation. Only required when repository_selection is 'selected'", - "items": { - "type": "string" - }, - "maxItems": 50 - } - }, - "required": [ - "repository_selection" - ] - }, - "examples": { - "default": { - "summary": "Change the repositories accessible to a GitHub App from 'all repositories' to a specified subset.", - "value": { - "repository_selection": "selected", - "repositories": [ - "hello-world", - "hello-world-2" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "The GitHub App installation that was updated.", - "content": { - "application/json": { - "schema": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/app/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "Iv1.ab1112223334445c" - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "custom_properties_for_organizations": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -51724,6 +51628,1139 @@ } } }, + "/enterprises/{enterprise}/installation": { + "get": { + "summary": "Get an enterprise installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find its installation on a particular enterprise.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-enterprise-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "enterprise_organization_installations": { + "type": "string", + "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_organization_installation_repositories": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository access of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "account": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/orgs/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "all", + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "client_id": "Iv1.ab1112223334445c", + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "created_at": "2018-02-09T20:51:14Z", + "updated_at": "2018-02-09T20:51:14Z", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, "/enterprises/{enterprise}/license-sync-status": { "get": { "summary": "Get a license sync status", @@ -58117,7 +59154,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58164,7 +59201,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58211,7 +59248,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58258,7 +59295,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58305,7 +59342,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58621,7 +59658,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -58642,7 +59679,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -59475,7 +60512,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59522,7 +60559,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59569,7 +60606,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59616,7 +60653,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59663,7 +60700,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59984,7 +61021,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -60002,7 +61039,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -60939,7 +61976,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -60986,7 +62023,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61033,7 +62070,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61080,7 +62117,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61127,7 +62164,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61448,7 +62485,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -61466,7 +62503,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -62772,7 +63809,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62819,7 +63856,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62866,7 +63903,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62913,7 +63950,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62960,7 +63997,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -63272,7 +64309,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -63293,7 +64330,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -64126,7 +65163,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64173,7 +65210,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64220,7 +65257,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64267,7 +65304,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64314,7 +65351,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64635,7 +65672,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -64653,7 +65690,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -64928,7 +65965,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -65109,41 +66146,39 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "repository", - "source_type": "Enterprise", - "source": "my-enterprise", - "enforcement": "active", - "conditions": { - "organization_name": { - "include": [ - "important_organization" - ] - }, - "repository_name": { - "include": [ - "~ALL" - ] - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] }, - "rules": [ - { - "type": "repository_delete" - } - ] - } + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ] } - ] + } } } } @@ -84848,6 +85883,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -117023,6 +118065,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -146187,7 +147236,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record": { "post": { "summary": "Create an artifact deployment record", - "description": "Create or update deployment records for an artifact associated with an organization.\nThis endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment.", + "description": "Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.", "tags": [ "orgs" ], @@ -146266,7 +147315,7 @@ }, "deployment_name": { "type": "string", - "description": "The name of the deployment." + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n" }, "tags": { "type": "object", @@ -155547,6 +156596,16 @@ ], "default": "disabled" }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, "code_scanning_options": { "type": [ "object", @@ -157349,6 +158408,15 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -164493,7 +165561,7 @@ }, "cli": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "description": "The organization policy for allowing or disallowing Copilot CLI.", "enum": [ "enabled", "disabled", @@ -185345,6 +186413,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -192289,7 +193364,6 @@ "subject_type": "installation", "subject_id": 954453, "subject_name": "GitHub Actions", - "integration_id": 124345, "total_request_count": 544665, "rate_limited_request_count": 13, "last_request_timestamp": "2024-09-18T15:43:03Z", @@ -193905,14 +194979,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -195076,14 +196142,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -264833,7 +265891,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -264880,7 +265938,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -264927,7 +265985,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -264974,7 +266032,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -265021,7 +266079,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266116,7 +267174,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266163,7 +267221,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266210,7 +267268,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266257,7 +267315,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266304,7 +267362,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267489,7 +268547,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267536,7 +268594,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267583,7 +268641,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267630,7 +268688,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267677,7 +268735,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269520,7 +270578,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269567,7 +270625,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269614,7 +270672,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269661,7 +270719,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269708,7 +270766,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270828,7 +271886,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270875,7 +271933,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270922,7 +271980,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270969,7 +272027,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -271016,7 +272074,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272197,7 +273255,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272244,7 +273302,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272291,7 +273349,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272338,7 +273396,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272385,7 +273443,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -273013,7 +274071,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -273194,61 +274252,59 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -444268,6 +445324,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -463240,14 +464303,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -474738,6 +475793,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -475665,6 +476727,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -476530,6 +477599,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -501774,6 +502850,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -502675,6 +503758,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -557267,6 +558357,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -629102,7 +630199,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629175,7 +630272,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629248,7 +630345,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629321,7 +630418,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629394,7 +630491,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630848,7 +631945,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630895,7 +631992,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630942,7 +632039,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630989,7 +632086,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -631036,7 +632133,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -631998,7 +633095,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632045,7 +633142,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632092,7 +633189,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632139,7 +633236,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632186,7 +633283,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633361,7 +634458,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633408,7 +634505,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633455,7 +634552,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633502,7 +634599,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633549,7 +634646,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635411,7 +636508,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635458,7 +636555,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635505,7 +636602,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635552,7 +636649,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635599,7 +636696,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636576,7 +637673,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636623,7 +637720,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636670,7 +637767,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636717,7 +637814,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636764,7 +637861,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -637935,7 +639032,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -637982,7 +639079,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638029,7 +639126,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638076,7 +639173,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638123,7 +639220,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638759,7 +639856,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -638949,51 +640046,49 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -731121,14 +732216,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -784772,6 +785859,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -795691,6 +796785,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -806620,6 +807721,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -812253,14 +813361,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -844269,6 +845369,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -855184,6 +856291,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -890316,7 +891430,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -890371,7 +891484,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -895292,7 +896404,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -895347,7 +896458,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -900266,7 +901376,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -900321,7 +901430,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -905257,7 +906365,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -905312,7 +906419,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -906035,13 +907141,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -908834,13 +909933,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -911626,13 +912718,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -965913,13 +966998,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -985860,666 +986938,652 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "production_environment": { - "type": "boolean" - }, - "ref": { - "type": "string" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "task": { - "type": "string" - }, - "transient_environment": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "sha", - "ref", - "task", - "payload", - "original_environment", - "environment", - "description", - "creator", - "created_at", - "updated_at", - "statuses_url", - "repository_url" - ] - }, - "deployment_status": { - "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses).", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "description": { - "description": "The optional human-readable description added to the status.", - "type": "string" - }, - "environment": { - "type": "string" - }, - "environment_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "log_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "pull_request_review_thread", - "merge_queue_entry", - "workflow_job", - "merge_group", - "secret_scanning_alert_location" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "production_environment": { + "type": "boolean" + }, + "ref": { + "type": "string" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "task": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", + "created_at", + "updated_at", + "statuses_url", + "repository_url" + ] + }, + "deployment_status": { + "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "deployment_url": { + "type": "string", + "format": "uri" + }, + "description": { + "description": "The optional human-readable description added to the status.", + "type": "string" + }, + "environment": { + "type": "string" + }, + "environment_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "log_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job", + "merge_group", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { "type": "string", "enum": [ "read", @@ -1079215,14 +1080279,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1082346,14 +1083402,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1085382,14 +1086430,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1088418,14 +1089458,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1091588,14 +1092620,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1094765,14 +1095789,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1099937,14 +1100953,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1102235,411 +1103243,9047 @@ "type": "string" }, "performed_via_github_app": { - "anyOf": [ - { - "type": "null" + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the comment.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "issues": { - "type": "string" + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "checks": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "metadata": { - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "contents": { - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "deployments": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 ] } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, "reactions": { @@ -1102784,7 +1112428,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1102799,6 +1112444,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -1103850,8 +1113502,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "secret_scanning_alerts": { @@ -1103896,13 +1113547,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1106400,6 +1116044,7 @@ }, "required": [ "action", + "changes", "issue", "comment", "repository", @@ -1106426,11 +1116071,11 @@ } } }, - "issue-comment-deleted": { + "issue-comment-pinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, @@ -1106497,13 +1116142,13 @@ "content": { "application/json": { "schema": { - "title": "issue_comment deleted event", + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "pinned" ] }, "comment": { @@ -1107109,6 +1116754,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -1110735,11 +1120387,11 @@ } } }, - "issue-comment-edited": { + "issue-comment-unpinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, @@ -1110806,33 +1120458,15 @@ "content": { "application/json": { "schema": { - "title": "issue_comment edited event", + "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "unpinned" ] }, - "changes": { - "description": "The changes to the comment.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "comment": { "title": "issue comment", "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", @@ -1111436,6 +1121070,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -1112173,9 +1121814,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -1112430,8 +1122069,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -1113264,6 +1122902,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -1115036,7 +1124677,6 @@ }, "required": [ "action", - "changes", "issue", "comment", "repository", @@ -1151040,13 +1160680,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1154489,13 +1164122,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1158146,13 +1167772,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1161618,13 +1171237,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1165249,13 +1174861,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1168734,13 +1178339,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1172258,13 +1181856,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1175695,13 +1185286,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1179183,13 +1188767,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1181375,13 +1190952,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1184812,13 +1194382,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1188287,13 +1197850,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1191579,13 +1201135,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1193787,13 +1203336,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1197231,13 +1206773,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1200844,13 +1210379,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1204288,13 +1213816,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1207810,13 +1217331,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1211213,13 +1220727,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1214656,13 +1224163,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1556104,7 +1565604,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556151,7 +1565651,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556198,7 +1565698,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556245,7 +1565745,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556292,7 +1565792,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559405,7 +1568905,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559452,7 +1568952,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559499,7 +1568999,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559546,7 +1569046,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559593,7 +1569093,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562706,7 +1572206,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562753,7 +1572253,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562800,7 +1572300,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562847,7 +1572347,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562894,7 +1572394,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563780,7 +1573280,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563827,7 +1573327,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563874,7 +1573374,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563921,7 +1573421,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563968,7 +1573468,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564682,7 +1574182,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564729,7 +1574229,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564776,7 +1574276,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564823,7 +1574323,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564870,7 +1574370,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565587,7 +1575087,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565634,7 +1575134,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565681,7 +1575181,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565728,7 +1575228,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565775,7 +1575275,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1570709,6 +1580209,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } @@ -1575021,6 +1584522,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 41aacf5f5..72203a49e 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -913,7 +913,7 @@ paths: - subscriptions_url - type - url - type: &424 + type: &425 type: string description: The type of credit the user is receiving. enum: @@ -2665,13 +2665,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 @@ -13542,7 +13535,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &512 + instances_url: &513 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13578,7 +13571,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &513 + dismissed_reason: &514 type: - string - 'null' @@ -13589,14 +13582,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &514 + dismissed_comment: &515 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &515 + rule: &516 type: object properties: id: @@ -13657,7 +13650,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &516 + tool: &517 type: object properties: name: *109 @@ -13668,26 +13661,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *110 - most_recent_instance: &517 + most_recent_instance: &518 type: object properties: - ref: &510 + ref: &511 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &527 + analysis_key: &528 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &528 + environment: &529 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &529 + category: &530 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13701,7 +13694,7 @@ paths: properties: text: type: string - location: &530 + location: &531 type: object description: Describe a region within a file for the alert. properties: @@ -13722,7 +13715,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &531 + items: &532 type: - string - 'null' @@ -16104,7 +16097,7 @@ paths: parent: anyOf: - type: 'null' - - &371 + - &372 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -17497,7 +17490,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &568 + - &569 name: has in: query description: |- @@ -17614,7 +17607,7 @@ paths: - direct - transitive - - security_advisory: &569 + security_advisory: &570 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17850,7 +17843,7 @@ paths: dismissal. maxLength: 280 fixed_at: *134 - auto_dismissed_at: &570 + auto_dismissed_at: &571 type: - string - 'null' @@ -17858,7 +17851,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &571 + dismissal_request: &572 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -18851,6 +18844,80 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles + "/enterprises/{enterprise}/installation": + get: + summary: Get an enterprise installation for the authenticated app + description: |- + Enables an authenticated GitHub App to find its installation on a particular enterprise. + + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/get-enterprise-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app + parameters: + - *39 + responses: + '200': + description: Response + content: + application/json: + schema: *20 + examples: + default: &352 + value: + id: 1 + account: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/orgs/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + repository_selection: all + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + client_id: Iv1.ab1112223334445c + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + created_at: '2018-02-09T20:51:14Z' + updated_at: '2018-02-09T20:51:14Z' + single_file_name: config.yml + has_multiple_single_files: true + single_file_paths: + - config.yml + - ".github/issue_TEMPLATE.md" + app_slug: github-actions + suspended_at: + suspended_by: + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: apps + subcategory: apps "/enterprises/{enterprise}/license-sync-status": get: summary: Get a license sync status @@ -19060,7 +19127,7 @@ paths: - name - created_on examples: - default: &428 + default: &429 value: total_count: 2 network_configurations: @@ -19285,7 +19352,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *39 - - &429 + - &430 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -19297,7 +19364,7 @@ paths: description: Response content: application/json: - schema: &430 + schema: &431 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -19336,7 +19403,7 @@ paths: - subnet_id - region examples: - default: &431 + default: &432 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -20185,7 +20252,7 @@ paths: required: true content: application/json: - schema: &402 + schema: &403 title: Custom Property Set Payload description: Custom property set payload type: object @@ -20890,7 +20957,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 @@ -20926,7 +20994,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 @@ -20962,7 +21031,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 @@ -20998,7 +21068,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 @@ -21034,7 +21105,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 @@ -21288,7 +21360,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -21301,7 +21373,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '201': description: Response @@ -21379,7 +21451,7 @@ paths: conditions: anyOf: - *156 - - &406 + - &407 title: Organization ruleset conditions type: object description: |- @@ -21544,7 +21616,7 @@ paths: value: id: 21 name: super cool ruleset - target: repository + target: branch source_type: Enterprise source: my-enterprise enforcement: active @@ -21556,7 +21628,7 @@ paths: include: - "~ALL" rules: - - type: repository_delete + - type: deletion node_id: RRS_lACkVXNlcgQB _links: self: @@ -21659,7 +21731,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -21672,7 +21744,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '200': description: Response @@ -21766,13 +21838,13 @@ paths: type: string format: date-time examples: - default: &409 + default: &410 value: - version_id: 3 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 @@ -21819,7 +21891,7 @@ paths: description: Response content: application/json: - schema: &410 + schema: &411 allOf: - *189 - type: object @@ -21832,11 +21904,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 @@ -21874,7 +21946,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *39 - - &411 + - &412 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -21885,7 +21957,7 @@ paths: enum: - open - resolved - - &412 + - &413 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -21895,7 +21967,7 @@ paths: required: false schema: type: string - - &413 + - &414 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -21904,7 +21976,7 @@ paths: required: false schema: type: string - - &414 + - &415 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -21923,7 +21995,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &415 + - &416 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -21939,7 +22011,7 @@ paths: - *17 - *106 - *107 - - &416 + - &417 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21948,7 +22020,7 @@ paths: required: false schema: type: string - - &417 + - &418 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21957,7 +22029,7 @@ paths: schema: type: boolean default: false - - &418 + - &419 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21966,7 +22038,7 @@ paths: schema: type: boolean default: false - - &419 + - &420 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21982,7 +22054,7 @@ paths: application/json: schema: type: array - items: &420 + items: &421 type: object properties: number: *124 @@ -22412,7 +22484,7 @@ paths: - type: 'null' - *4 examples: - default: &421 + default: &422 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -22621,7 +22693,7 @@ paths: description: Response content: application/json: - schema: &422 + schema: &423 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -22708,7 +22780,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *191 examples: - default: &423 + default: &424 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -22844,7 +22916,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &425 + - &426 name: advanced_security_product in: query description: | @@ -22864,7 +22936,7 @@ paths: description: Success content: application/json: - schema: &426 + schema: &427 type: object properties: total_advanced_security_committers: @@ -22927,7 +22999,7 @@ paths: required: - repositories examples: - default: &427 + default: &428 value: total_advanced_security_committers: 2 total_count: 2 @@ -26287,7 +26359,7 @@ paths: milestone: anyOf: - type: 'null' - - &392 + - &393 title: Milestone description: A collection of related issues and pull requests. @@ -26459,7 +26531,7 @@ paths: timeline_url: type: string format: uri - type: &358 + type: &359 title: Issue Type description: The type of issue. type: @@ -26779,6 +26851,9 @@ paths: - type: 'null' - *5 reactions: *215 + pin: + anyOf: + - type: 'null' required: - id - node_id @@ -30016,7 +30091,7 @@ paths: - closed - all default: open - - &361 + - &362 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -30067,7 +30142,7 @@ paths: type: array items: *213 examples: - default: &362 + default: &363 value: - id: 1 node_id: MDU6SXNzdWUx @@ -31478,14 +31553,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &439 + - &440 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &440 + - &441 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -31547,7 +31622,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &445 + '301': &446 description: Moved permanently content: application/json: @@ -31960,7 +32035,7 @@ paths: type: boolean examples: - false - security_and_analysis: &403 + security_and_analysis: &404 type: - object - 'null' @@ -34203,7 +34278,7 @@ paths: type: integer repository_cache_usages: type: array - items: &452 + items: &453 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -37379,7 +37454,7 @@ paths: description: Response content: application/json: - schema: &472 + schema: &473 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -37414,7 +37489,7 @@ paths: - key_id - key examples: - default: &473 + default: &474 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -37827,7 +37902,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *85 - - &457 + - &458 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -38379,8 +38454,19 @@ paths: post: summary: Create an artifact deployment record description: |- - Create or update deployment records for an artifact associated with an organization. - This endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment. + Create or update deployment records for an artifact associated + with an organization. + This endpoint allows you to record information about a specific + artifact, such as its name, digest, environments, cluster, and + deployment. + The deployment name has to be uniqe within a cluster (i.e a + combination of logical, physical environment and cluster) as it + identifies unique deployment. + Multiple requests for the same combination of logical, physical + environment, cluster and deployment name will only create one + record, successive request will update the existing record. + This allows for a stable tracking of a deployment where the actual + deployed artifact can change over time. tags: - orgs operationId: orgs/create-artifact-deployment-record @@ -38439,7 +38525,10 @@ paths: description: The deployment cluster. deployment_name: type: string - description: The name of the deployment. + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a cluster, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. tags: type: object description: The tags associated with the deployment. @@ -39480,7 +39569,7 @@ paths: initiator: type: string examples: - default: &486 + default: &487 value: attestations: - bundle: @@ -40402,7 +40491,7 @@ paths: be returned. in: query required: false - schema: &511 + schema: &512 type: string description: Severity of a code scanning alert. enum: @@ -40645,6 +40734,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: *116 code_scanning_default_setup: type: string @@ -41002,6 +41100,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 @@ -41427,7 +41533,7 @@ paths: type: integer codespaces: type: array - items: &363 + items: &364 type: object title: Codespace description: A codespace. @@ -41462,7 +41568,7 @@ paths: machine: anyOf: - type: 'null' - - &543 + - &544 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -41749,7 +41855,7 @@ paths: - pulls_url - recent_folders examples: - default: &364 + default: &365 value: total_count: 3 codespaces: @@ -42414,7 +42520,7 @@ paths: - updated_at - visibility examples: - default: &544 + default: &545 value: total_count: 2 secrets: @@ -42452,7 +42558,7 @@ paths: description: Response content: application/json: - schema: &545 + schema: &546 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -42487,7 +42593,7 @@ paths: - key_id - key examples: - default: &546 + default: &547 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -42519,7 +42625,7 @@ paths: application/json: schema: *316 examples: - default: &548 + default: &549 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -42890,7 +42996,7 @@ paths: cli: type: string description: The organization policy for allowing or disallowing - Copilot in the CLI. + Copilot CLI. enum: - enabled - disabled @@ -44398,7 +44504,7 @@ paths: description: Response content: application/json: - schema: &574 + schema: &575 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -44417,7 +44523,7 @@ paths: - key_id - key examples: - default: &575 + default: &576 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -44747,7 +44853,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *85 - - &583 + - &584 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -44755,7 +44861,7 @@ paths: required: false schema: type: string - - &584 + - &585 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -44763,7 +44869,7 @@ paths: required: false schema: type: string - - &585 + - &586 name: time_period description: |- The time period to filter by. @@ -44779,7 +44885,7 @@ paths: - week - month default: month - - &586 + - &587 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -44804,7 +44910,7 @@ paths: application/json: schema: type: array - items: &587 + items: &588 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -44967,7 +45073,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &588 + default: &589 value: - id: 21 number: 42 @@ -45085,7 +45191,7 @@ paths: application/json: schema: type: array - items: &589 + items: &590 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -45208,7 +45314,7 @@ paths: examples: - https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &590 + default: &591 value: - id: 21 number: 42 @@ -45310,7 +45416,7 @@ paths: application/json: schema: type: array - items: &591 + items: &592 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -45437,7 +45543,7 @@ paths: examples: - https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &592 + default: &593 value: - id: 21 number: 42 @@ -45525,7 +45631,7 @@ paths: application/json: schema: type: array - items: &373 + items: &374 title: Package description: A software package type: object @@ -45596,7 +45702,7 @@ paths: - created_at - updated_at examples: - default: &374 + default: &375 value: - id: 197 name: hello_docker @@ -45783,7 +45889,7 @@ paths: description: Response content: application/json: - schema: &436 + schema: &437 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -45873,7 +45979,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &437 + default: &438 value: group_id: '123' group_name: Octocat admins @@ -45928,7 +46034,7 @@ paths: description: Response content: application/json: - schema: &434 + schema: &435 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -45968,7 +46074,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &435 + default: &436 value: groups: - group_id: '123' @@ -46012,7 +46118,7 @@ paths: application/json: schema: type: array - items: &355 + items: &356 title: Organization Invitation description: Organization Invitation type: object @@ -46066,7 +46172,7 @@ paths: - invitation_teams_url - node_id examples: - default: &356 + default: &357 value: - id: 1 login: monalisa @@ -46133,7 +46239,7 @@ paths: application/json: schema: type: array - items: &404 + items: &405 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -46147,7 +46253,7 @@ paths: - name - description examples: - default: &405 + default: &406 value: - name: add_assignee description: Assign or remove a user @@ -46950,7 +47056,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' @@ -47297,53 +47402,7 @@ paths: application/json: schema: *20 examples: - default: &623 - value: - id: 1 - account: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/orgs/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - received_events_url: https://api.github.com/users/github/received_events - type: Organization - site_admin: false - repository_selection: all - access_tokens_url: https://api.github.com/app/installations/1/access_tokens - repositories_url: https://api.github.com/installation/repositories - html_url: https://github.com/organizations/github/settings/installations/1 - app_id: 1 - client_id: Iv1.ab1112223334445c - target_id: 1 - target_type: Organization - permissions: - checks: write - metadata: read - contents: read - events: - - push - - pull_request - created_at: '2018-02-09T20:51:14Z' - updated_at: '2018-02-09T20:51:14Z' - single_file_name: config.yml - has_multiple_single_files: true - single_file_paths: - - config.yml - - ".github/issue_TEMPLATE.md" - app_slug: github-actions - suspended_at: - suspended_by: + default: *352 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47463,12 +47522,12 @@ paths: application/json: schema: anyOf: - - &353 + - &354 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &352 + limit: &353 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -47496,7 +47555,7 @@ paths: properties: {} additionalProperties: false examples: - default: &354 + default: &355 value: limit: collaborators_only origin: organization @@ -47531,7 +47590,7 @@ paths: duration type: object properties: - limit: *352 + limit: *353 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -47556,9 +47615,9 @@ paths: description: Response content: application/json: - schema: *353 + schema: *354 examples: - default: *354 + default: *355 '422': *15 x-github: githubCloudOnly: false @@ -47636,9 +47695,9 @@ paths: application/json: schema: type: array - items: *355 + items: *356 examples: - default: *356 + default: *357 headers: Link: *45 '404': *6 @@ -47716,7 +47775,7 @@ paths: description: Response content: application/json: - schema: *355 + schema: *356 examples: default: value: @@ -47773,7 +47832,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - *85 - - &357 + - &358 name: invitation_id description: The unique identifier of the invitation. in: path @@ -47807,7 +47866,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - *85 - - *357 + - *358 - *17 - *19 responses: @@ -47819,7 +47878,7 @@ paths: type: array items: *302 examples: - default: &372 + default: &373 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -47862,7 +47921,7 @@ paths: application/json: schema: type: array - items: *358 + items: *359 examples: default: value: @@ -47950,9 +48009,9 @@ paths: description: Response content: application/json: - schema: *358 + schema: *359 examples: - default: &359 + default: &360 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -47985,7 +48044,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *85 - - &360 + - &361 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -48041,9 +48100,9 @@ paths: description: Response content: application/json: - schema: *358 + schema: *359 examples: - default: *359 + default: *360 '404': *6 '422': *7 x-github: @@ -48068,7 +48127,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *85 - - *360 + - *361 responses: '204': description: Response @@ -48131,7 +48190,7 @@ paths: - closed - all default: open - - *361 + - *362 - name: type description: Can be the name of an issue type. in: query @@ -48162,7 +48221,7 @@ paths: type: array items: *213 examples: - default: *362 + default: *363 headers: Link: *45 '404': *6 @@ -48321,9 +48380,9 @@ paths: type: integer codespaces: type: array - items: *363 + items: *364 examples: - default: *364 + default: *365 '304': *35 '500': *38 '401': *23 @@ -48350,7 +48409,7 @@ paths: parameters: - *85 - *137 - - &365 + - &366 name: codespace_name in: path required: true @@ -48385,15 +48444,15 @@ paths: parameters: - *85 - *137 - - *365 + - *366 responses: '200': description: Response content: application/json: - schema: *363 + schema: *364 examples: - default: &542 + default: &543 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -48649,7 +48708,7 @@ paths: description: Response content: application/json: - schema: &366 + schema: &367 title: Org Membership description: Org Membership type: object @@ -48718,7 +48777,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &367 + response-if-user-has-an-active-admin-membership-with-organization: &368 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -48819,9 +48878,9 @@ paths: description: Response content: application/json: - schema: *366 + schema: *367 examples: - response-if-user-already-had-membership-with-organization: *367 + response-if-user-already-had-membership-with-organization: *368 '422': *15 '403': *27 x-github: @@ -48893,7 +48952,7 @@ paths: application/json: schema: type: array - items: &368 + items: &369 title: Migration description: A migration. type: object @@ -49231,7 +49290,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *369 examples: default: value: @@ -49410,7 +49469,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - *85 - - &369 + - &370 name: migration_id description: The unique identifier of the migration. in: path @@ -49438,7 +49497,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *368 + schema: *369 examples: default: value: @@ -49608,7 +49667,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - *85 - - *369 + - *370 responses: '302': description: Response @@ -49630,7 +49689,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *85 - - *369 + - *370 responses: '204': description: Response @@ -49654,7 +49713,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - *85 - - *369 + - *370 - &788 name: repo_name description: repo_name parameter @@ -49683,7 +49742,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *85 - - *369 + - *370 - *17 - *19 responses: @@ -49695,7 +49754,7 @@ paths: type: array items: *273 examples: - default: &379 + default: &380 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -49904,7 +49963,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &370 + items: &371 title: Organization Role description: Organization roles type: object @@ -50113,7 +50172,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *371 examples: default: value: @@ -50343,7 +50402,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *371 examples: default: value: @@ -50440,7 +50499,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *371 examples: default: value: @@ -50599,7 +50658,7 @@ paths: parent: anyOf: - type: 'null' - - *371 + - *372 type: description: The ownership type of the team type: string @@ -50632,7 +50691,7 @@ paths: - type - parent examples: - default: *372 + default: *373 headers: Link: *45 '404': @@ -50691,7 +50750,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *371 + items: *372 name: type: - string @@ -51037,9 +51096,9 @@ paths: application/json: schema: type: array - items: *373 + items: *374 examples: - default: *374 + default: *375 '403': *27 '401': *23 '400': &791 @@ -51064,7 +51123,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &375 + - &376 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -51082,7 +51141,7 @@ paths: - docker - nuget - container - - &376 + - &377 name: package_name description: The name of the package. in: path @@ -51095,7 +51154,7 @@ paths: description: Response content: application/json: - schema: *373 + schema: *374 examples: default: value: @@ -51147,8 +51206,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *375 - *376 + - *377 - *85 responses: '204': @@ -51181,8 +51240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *375 - *376 + - *377 - *85 - name: token description: package token @@ -51215,8 +51274,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *375 - *376 + - *377 - *85 - *19 - *17 @@ -51237,7 +51296,7 @@ paths: application/json: schema: type: array - items: &377 + items: &378 title: Package Version description: A version of a software package type: object @@ -51372,10 +51431,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *375 - *376 + - *377 - *85 - - &378 + - &379 name: package_version_id description: Unique identifier of the package version. in: path @@ -51387,7 +51446,7 @@ paths: description: Response content: application/json: - schema: *377 + schema: *378 examples: default: value: @@ -51423,10 +51482,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *375 - *376 + - *377 - *85 - - *378 + - *379 responses: '204': description: Response @@ -51458,10 +51517,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *375 - *376 + - *377 - *85 - - *378 + - *379 responses: '204': description: Response @@ -51491,7 +51550,7 @@ paths: - *85 - *17 - *19 - - &380 + - &381 name: sort description: The property by which to sort the results. in: query @@ -51502,7 +51561,7 @@ paths: - created_at default: created_at - *108 - - &381 + - &382 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -51514,7 +51573,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &382 + - &383 name: repository description: The name of the repository to use to filter the results. in: query @@ -51523,7 +51582,7 @@ paths: type: string examples: - Hello-World - - &383 + - &384 name: permission description: The permission to use to filter the results. in: query @@ -51532,7 +51591,7 @@ paths: type: string examples: - issues_read - - &384 + - &385 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -51542,7 +51601,7 @@ paths: schema: type: string format: date-time - - &385 + - &386 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -51552,7 +51611,7 @@ paths: schema: type: string format: date-time - - &386 + - &387 name: token_id description: The ID of the token in: query @@ -51871,7 +51930,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -51897,14 +51956,14 @@ paths: - *85 - *17 - *19 - - *380 - - *108 - *381 + - *108 - *382 - *383 - *384 - *385 - *386 + - *387 responses: '500': *38 '422': *15 @@ -52188,7 +52247,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -52230,7 +52289,7 @@ paths: type: integer configurations: type: array - items: &387 + items: &388 title: Organization private registry description: Private registry configuration for an organization type: object @@ -52526,7 +52585,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &388 + org-private-registry-with-selected-visibility: &389 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -52624,9 +52683,9 @@ paths: description: The specified private registry configuration for the organization content: application/json: - schema: *387 + schema: *388 examples: - default: *388 + default: *389 '404': *6 x-github: githubCloudOnly: false @@ -52794,7 +52853,7 @@ paths: application/json: schema: type: array - items: &389 + items: &390 title: Projects v2 Project description: A projects v2 project type: object @@ -52953,7 +53012,7 @@ paths: - deleted_at - deleted_by examples: - default: &390 + default: &391 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -53056,7 +53115,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &391 + - &392 name: project_number description: The project's number. in: path @@ -53069,9 +53128,9 @@ paths: description: Response content: application/json: - schema: *389 + schema: *390 examples: - default: *390 + default: *391 headers: Link: *45 '304': *35 @@ -53094,7 +53153,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *85 - - *391 + - *392 requestBody: required: true description: Details of the draft item to create in the project. @@ -53128,7 +53187,7 @@ paths: description: Response content: application/json: - schema: &396 + schema: &397 title: Projects v2 Item description: An item belonging to a project type: object @@ -53142,7 +53201,7 @@ paths: content: oneOf: - *213 - - &557 + - &558 title: Pull Request Simple description: Pull Request Simple type: object @@ -53262,7 +53321,7 @@ paths: milestone: anyOf: - type: 'null' - - *392 + - *393 active_lock_reason: type: - string @@ -53361,7 +53420,7 @@ paths: _links: type: object properties: - comments: &393 + comments: &394 title: Link description: Hypermedia Link type: object @@ -53370,13 +53429,13 @@ paths: type: string required: - href - commits: *393 - statuses: *393 - html: *393 - issue: *393 - review_comments: *393 - review_comment: *393 - self: *393 + commits: *394 + statuses: *394 + html: *394 + issue: *394 + review_comments: *394 + review_comment: *394 + self: *394 required: - comments - commits @@ -53489,7 +53548,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &395 + content_type: &396 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -53533,7 +53592,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &397 + draft_issue: &398 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -53607,7 +53666,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *391 + - *392 - *85 - *17 - *106 @@ -53619,7 +53678,7 @@ paths: application/json: schema: type: array - items: &394 + items: &395 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -53899,7 +53958,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *391 + - *392 - *85 requestBody: required: true @@ -54082,7 +54141,7 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *394 + schema: *395 examples: text_field: &815 value: @@ -54190,7 +54249,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *391 + - *392 - &820 name: field_id description: The unique identifier of the field. @@ -54204,7 +54263,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *395 examples: default: &821 value: @@ -54262,7 +54321,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *391 + - *392 - *85 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -54295,7 +54354,7 @@ paths: application/json: schema: type: array - items: &398 + items: &399 title: Projects v2 Item description: An item belonging to a project type: object @@ -54312,7 +54371,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: *395 + content_type: *396 content: type: - object @@ -54362,7 +54421,7 @@ paths: - updated_at - archived_at examples: - default: &399 + default: &400 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -55059,7 +55118,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - *85 - - *391 + - *392 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -55129,22 +55188,22 @@ paths: description: Response content: application/json: - schema: *396 + schema: *397 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *397 + value: *398 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *397 + value: *398 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *397 + value: *398 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *397 + value: *398 '304': *35 '403': *27 '401': *23 @@ -55164,9 +55223,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *391 + - *392 - *85 - - &400 + - &401 name: item_id description: The unique identifier of the project item. in: path @@ -55192,9 +55251,9 @@ paths: description: Response content: application/json: - schema: *398 + schema: *399 examples: - default: *399 + default: *400 headers: Link: *45 '304': *35 @@ -55215,9 +55274,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *391 + - *392 - *85 - - *400 + - *401 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -55290,13 +55349,13 @@ paths: description: Response content: application/json: - schema: *398 + schema: *399 examples: - text_field: *399 - number_field: *399 - date_field: *399 - single_select_field: *399 - iteration_field: *399 + text_field: *400 + number_field: *400 + date_field: *400 + single_select_field: *400 + iteration_field: *400 '401': *23 '403': *27 '404': *6 @@ -55316,9 +55375,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *391 + - *392 - *85 - - *400 + - *401 responses: '204': description: Response @@ -55342,7 +55401,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *85 - - *391 + - *392 requestBody: required: true content: @@ -55520,7 +55579,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &401 + value: &402 value: id: 1 number: 1 @@ -55566,10 +55625,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *401 + value: *402 roadmap_view: summary: Response for creating a roadmap view - value: *401 + value: *402 '304': *35 '403': *27 '401': *23 @@ -55597,7 +55656,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-project-view parameters: - - *391 + - *392 - *85 - &822 name: view_number @@ -55631,9 +55690,9 @@ paths: application/json: schema: type: array - items: *398 + items: *399 examples: - default: *399 + default: *400 headers: Link: *45 '304': *35 @@ -55797,7 +55856,7 @@ paths: required: true content: application/json: - schema: *402 + schema: *403 examples: default: value: @@ -56165,7 +56224,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -56369,7 +56428,7 @@ paths: description: Response content: application/json: - schema: &444 + schema: &445 title: Full Repository description: Full Repository type: object @@ -56834,7 +56893,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &562 + code_of_conduct: &563 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -56864,7 +56923,7 @@ paths: - key - name - html_url - security_and_analysis: *403 + security_and_analysis: *404 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -56948,7 +57007,7 @@ paths: - network_count - subscribers_count examples: - default: &446 + default: &447 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -57474,9 +57533,9 @@ paths: application/json: schema: type: array - items: *404 + items: *405 examples: - default: *405 + default: *406 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57593,11 +57652,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *163 - conditions: *406 + conditions: *407 rules: type: array description: An array of rules within the ruleset. - items: &408 + items: &409 title: Repository Rule type: object description: A repository rule. @@ -57662,7 +57721,7 @@ paths: application/json: schema: *185 examples: - default: &407 + default: &408 value: id: 21 name: super cool ruleset @@ -58054,7 +58113,7 @@ paths: application/json: schema: *185 examples: - default: *407 + default: *408 '404': *6 '500': *38 put: @@ -58103,11 +58162,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *163 - conditions: *406 + conditions: *407 rules: description: An array of rules within the ruleset. type: array - items: *408 + items: *409 examples: default: value: @@ -58144,7 +58203,7 @@ paths: application/json: schema: *185 examples: - default: *407 + default: *408 '404': *6 '500': *38 delete: @@ -58203,7 +58262,7 @@ paths: type: array items: *189 examples: - default: *409 + default: *410 '404': *6 '500': *38 x-github: @@ -58240,15 +58299,15 @@ paths: description: Response content: application/json: - schema: *410 + schema: *411 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 @@ -58303,11 +58362,11 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *85 - - *411 - *412 - *413 - *414 - *415 + - *416 - *108 - *19 - *17 @@ -58331,10 +58390,10 @@ paths: required: false schema: type: string - - *416 - *417 - *418 - *419 + - *420 responses: '200': description: Response @@ -58342,9 +58401,9 @@ paths: application/json: schema: type: array - items: *420 + items: *421 examples: - default: *421 + default: *422 headers: Link: *45 '404': *6 @@ -58379,9 +58438,9 @@ paths: description: Response content: application/json: - schema: *422 + schema: *423 examples: - default: *423 + default: *424 '403': *27 '404': *6 patch: @@ -58778,7 +58837,7 @@ paths: login: type: string description: The username of the user credited. - type: *424 + type: *425 credits_detailed: type: - array @@ -58789,7 +58848,7 @@ paths: type: object properties: user: *4 - type: *424 + type: *425 state: type: string description: The state of the user's acceptance of the @@ -59240,9 +59299,9 @@ paths: application/json: schema: type: array - items: *371 + items: *372 examples: - default: *372 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59324,7 +59383,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *85 - - *425 + - *426 - *17 - *19 responses: @@ -59332,9 +59391,9 @@ paths: description: Success content: application/json: - schema: *426 + schema: *427 examples: - default: *427 + default: *428 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -59617,7 +59676,7 @@ paths: type: array items: *142 examples: - default: *428 + default: *429 headers: Link: *45 x-github: @@ -59820,15 +59879,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *85 - - *429 + - *430 responses: '200': description: Response content: application/json: - schema: *430 + schema: *431 examples: - default: *431 + default: *432 headers: Link: *45 x-github: @@ -59866,7 +59925,7 @@ paths: description: Response content: application/json: - schema: &441 + schema: &442 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -59918,7 +59977,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &442 + default: &443 value: groups: - group_id: '123' @@ -60032,7 +60091,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 headers: Link: *45 '403': *27 @@ -60126,7 +60185,7 @@ paths: description: Response content: application/json: - schema: &432 + schema: &433 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -60200,7 +60259,7 @@ paths: parent: anyOf: - type: 'null' - - *371 + - *372 members_count: type: integer examples: @@ -60525,7 +60584,7 @@ paths: - repos_count - organization examples: - default: &433 + default: &434 value: id: 1 node_id: MDQ6VGVhbTE= @@ -60602,9 +60661,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '404': *6 x-github: githubCloudOnly: false @@ -60689,16 +60748,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '201': description: Response content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '404': *6 '422': *15 '403': *27 @@ -60754,9 +60813,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *435 examples: - default: *435 + default: *436 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -60800,9 +60859,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *437 examples: - default: *437 + default: *438 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -60857,9 +60916,9 @@ paths: application/json: schema: type: array - items: *355 + items: *356 examples: - default: *356 + default: *357 headers: Link: *45 x-github: @@ -60943,7 +61002,7 @@ paths: description: Response content: application/json: - schema: &438 + schema: &439 title: Team Membership description: Team Membership type: object @@ -61034,7 +61093,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *439 examples: response-if-users-membership-with-team-is-now-pending: &770 summary: Response if user's membership with team is now pending @@ -61112,7 +61171,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -61143,8 +61202,8 @@ paths: parameters: - *85 - *210 - - *439 - *440 + - *441 responses: '200': description: Alternative response with repository permissions @@ -61793,8 +61852,8 @@ paths: parameters: - *85 - *210 - - *439 - *440 + - *441 requestBody: required: false content: @@ -61841,8 +61900,8 @@ paths: parameters: - *85 - *210 - - *439 - *440 + - *441 responses: '204': description: Response @@ -61875,9 +61934,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *442 examples: - default: *442 + default: *443 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -61943,7 +62002,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *442 examples: default: value: @@ -62142,7 +62201,7 @@ paths: resources: type: object properties: - core: &443 + core: &444 title: Rate Limit type: object properties: @@ -62159,21 +62218,21 @@ paths: - remaining - reset - used - graphql: *443 - search: *443 - code_search: *443 - source_import: *443 - integration_manifest: *443 - code_scanning_upload: *443 - actions_runner_registration: *443 - scim: *443 - dependency_snapshots: *443 - dependency_sbom: *443 - code_scanning_autofix: *443 + graphql: *444 + search: *444 + code_search: *444 + source_import: *444 + integration_manifest: *444 + code_scanning_upload: *444 + actions_runner_registration: *444 + scim: *444 + dependency_snapshots: *444 + dependency_sbom: *444 + code_scanning_autofix: *444 required: - core - search - rate: *443 + rate: *444 required: - rate - resources @@ -62278,14 +62337,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: *444 + schema: *445 examples: default-response: summary: Default response @@ -62790,7 +62849,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *445 + '301': *446 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62808,8 +62867,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -63067,10 +63126,10 @@ paths: description: Response content: application/json: - schema: *444 + schema: *445 examples: - default: *446 - '307': &447 + default: *447 + '307': &448 description: Temporary Redirect content: application/json: @@ -63099,8 +63158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -63122,7 +63181,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *447 + '307': *448 '404': *6 '409': *117 x-github: @@ -63146,11 +63205,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *439 - *440 + - *441 - *17 - *19 - - &464 + - &465 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -63173,7 +63232,7 @@ paths: type: integer artifacts: type: array - items: &448 + items: &449 title: Artifact description: An artifact type: object @@ -63268,7 +63327,7 @@ paths: - expires_at - updated_at examples: - default: &465 + default: &466 value: total_count: 2 artifacts: @@ -63329,9 +63388,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *439 - *440 - - &449 + - *441 + - &450 name: artifact_id description: The unique identifier of the artifact. in: path @@ -63343,7 +63402,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *449 examples: default: value: @@ -63381,9 +63440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *439 - *440 - - *449 + - *441 + - *450 responses: '204': description: Response @@ -63407,9 +63466,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *439 - *440 - - *449 + - *441 + - *450 - name: archive_format in: path required: true @@ -63448,14 +63507,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: &450 + schema: &451 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -63489,13 +63548,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: application/json: - schema: *450 + schema: *451 examples: selected_actions: *42 responses: @@ -63524,14 +63583,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: &451 + schema: &452 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -63565,13 +63624,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: application/json: - schema: *451 + schema: *452 examples: selected_actions: *44 responses: @@ -63602,14 +63661,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: *452 + schema: *453 examples: default: value: @@ -63635,11 +63694,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *439 - *440 + - *441 - *17 - *19 - - &453 + - &454 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -63673,7 +63732,7 @@ paths: description: Response content: application/json: - schema: &454 + schema: &455 title: Repository actions caches description: Repository actions caches type: object @@ -63723,7 +63782,7 @@ paths: - total_count - actions_caches examples: - default: &455 + default: &456 value: total_count: 1 actions_caches: @@ -63755,23 +63814,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *439 - *440 + - *441 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *453 + - *454 responses: '200': description: Response content: application/json: - schema: *454 + schema: *455 examples: - default: *455 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63791,8 +63850,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *439 - *440 + - *441 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -63823,9 +63882,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *439 - *440 - - &456 + - *441 + - &457 name: job_id description: The unique identifier of the job. in: path @@ -63837,7 +63896,7 @@ paths: description: Response content: application/json: - schema: &468 + schema: &469 title: Job description: Information of a job execution in a workflow run type: object @@ -64184,9 +64243,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *439 - *440 - - *456 + - *441 + - *457 responses: '302': description: Response @@ -64214,9 +64273,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *439 - *440 - - *456 + - *441 + - *457 requestBody: required: false content: @@ -64262,8 +64321,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Status response @@ -64313,8 +64372,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -64377,8 +64436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -64396,7 +64455,7 @@ paths: type: integer secrets: type: array - items: &470 + items: &471 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -64417,7 +64476,7 @@ paths: - created_at - updated_at examples: - default: &471 + default: &472 value: total_count: 2 secrets: @@ -64450,9 +64509,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *439 - *440 - - *457 + - *441 + - *458 - *19 responses: '200': @@ -64469,7 +64528,7 @@ paths: type: integer variables: type: array - items: &474 + items: &475 title: Actions Variable type: object properties: @@ -64503,7 +64562,7 @@ paths: - created_at - updated_at examples: - default: &475 + default: &476 value: total_count: 2 variables: @@ -64536,8 +64595,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64546,7 +64605,7 @@ paths: schema: type: object properties: - enabled: &458 + enabled: &459 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *58 @@ -64581,8 +64640,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -64593,7 +64652,7 @@ paths: schema: type: object properties: - enabled: *458 + enabled: *459 allowed_actions: *58 sha_pinning_required: *59 required: @@ -64626,14 +64685,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: &459 + schema: &460 type: object properties: access_level: @@ -64651,7 +64710,7 @@ paths: required: - access_level examples: - default: &460 + default: &461 value: access_level: organization x-github: @@ -64676,15 +64735,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: application/json: - schema: *459 + schema: *460 examples: - default: *460 + default: *461 responses: '204': description: Response @@ -64708,8 +64767,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64739,8 +64798,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Empty response for successful settings update @@ -64774,8 +64833,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64802,8 +64861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -64837,8 +64896,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64866,8 +64925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -64898,8 +64957,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64930,8 +64989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -64963,8 +65022,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64993,8 +65052,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Success response @@ -65034,8 +65093,8 @@ paths: in: query schema: type: string - - *439 - *440 + - *441 - *17 - *19 responses: @@ -65079,8 +65138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -65112,8 +65171,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -65187,8 +65246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *439 - *440 + - *441 responses: '201': description: Response @@ -65224,8 +65283,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *439 - *440 + - *441 responses: '201': description: Response @@ -65255,8 +65314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 responses: '200': @@ -65286,8 +65345,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *439 - *440 + - *441 - *73 responses: '204': @@ -65314,8 +65373,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 responses: '200': *79 @@ -65340,8 +65399,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 requestBody: required: true @@ -65390,8 +65449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 requestBody: required: true @@ -65441,8 +65500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 responses: '200': *280 @@ -65472,8 +65531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 - *281 responses: @@ -65503,9 +65562,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *439 - *440 - - &478 + - *441 + - &479 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -65513,7 +65572,7 @@ paths: required: false schema: type: string - - &479 + - &480 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -65521,7 +65580,7 @@ paths: required: false schema: type: string - - &480 + - &481 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -65530,7 +65589,7 @@ paths: required: false schema: type: string - - &481 + - &482 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -65557,7 +65616,7 @@ paths: - pending - *17 - *19 - - &482 + - &483 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -65566,7 +65625,7 @@ paths: schema: type: string format: date-time - - &461 + - &462 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -65575,13 +65634,13 @@ paths: schema: type: boolean default: false - - &483 + - &484 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &484 + - &485 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -65604,7 +65663,7 @@ paths: type: integer workflow_runs: type: array - items: &462 + items: &463 title: Workflow Run description: An invocation of a workflow type: object @@ -65782,7 +65841,7 @@ paths: head_commit: anyOf: - type: 'null' - - &506 + - &507 title: Simple Commit description: A commit. type: object @@ -65897,7 +65956,7 @@ paths: - workflow_url - pull_requests examples: - default: &485 + default: &486 value: total_count: 1 workflow_runs: @@ -66133,24 +66192,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *439 - *440 - - &463 + - *441 + - &464 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *461 + - *462 responses: '200': description: Response content: application/json: - schema: *462 + schema: *463 examples: - default: &466 + default: &467 value: id: 30433642 name: Build @@ -66391,9 +66450,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '204': description: Response @@ -66416,9 +66475,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '200': description: Response @@ -66546,9 +66605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '201': description: Response @@ -66581,12 +66640,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *439 - *440 - - *463 + - *441 + - *464 - *17 - *19 - - *464 + - *465 responses: '200': description: Response @@ -66602,9 +66661,9 @@ paths: type: integer artifacts: type: array - items: *448 + items: *449 examples: - default: *465 + default: *466 headers: Link: *45 x-github: @@ -66628,25 +66687,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *439 - *440 - - *463 - - &467 + - *441 + - *464 + - &468 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *461 + - *462 responses: '200': description: Response content: application/json: - schema: *462 + schema: *463 examples: - default: *466 + default: *467 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66669,10 +66728,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *439 - *440 - - *463 - - *467 + - *441 + - *464 + - *468 - *17 - *19 responses: @@ -66690,9 +66749,9 @@ paths: type: integer jobs: type: array - items: *468 + items: *469 examples: - default: &469 + default: &470 value: total_count: 1 jobs: @@ -66805,10 +66864,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *439 - *440 - - *463 - - *467 + - *441 + - *464 + - *468 responses: '302': description: Response @@ -66836,9 +66895,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '202': description: Response @@ -66871,9 +66930,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 requestBody: required: true content: @@ -66940,9 +66999,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '202': description: Response @@ -66975,9 +67034,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -67007,9 +67066,9 @@ paths: type: integer jobs: type: array - items: *468 + items: *469 examples: - default: *469 + default: *470 headers: Link: *45 x-github: @@ -67034,9 +67093,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '302': description: Response @@ -67063,9 +67122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '204': description: Response @@ -67092,9 +67151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '200': description: Response @@ -67163,7 +67222,7 @@ paths: items: type: object properties: - type: &593 + type: &594 type: string description: The type of reviewer. enum: @@ -67249,9 +67308,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 requestBody: required: true content: @@ -67301,7 +67360,7 @@ paths: application/json: schema: type: array - items: &578 + items: &579 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -67413,7 +67472,7 @@ paths: - created_at - updated_at examples: - default: &579 + default: &580 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -67469,9 +67528,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *439 - *440 - - *463 + - *441 + - *464 requestBody: required: false content: @@ -67516,9 +67575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 requestBody: required: false content: @@ -67573,9 +67632,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '200': description: Response @@ -67712,8 +67771,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -67731,9 +67790,9 @@ paths: type: integer secrets: type: array - items: *470 + items: *471 examples: - default: *471 + default: *472 headers: Link: *45 x-github: @@ -67758,16 +67817,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: *472 + schema: *473 examples: - default: *473 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67789,17 +67848,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '200': description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: &606 + default: &607 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -67825,8 +67884,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 requestBody: required: true @@ -67884,8 +67943,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '204': @@ -67911,9 +67970,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *439 - *440 - - *457 + - *441 + - *458 - *19 responses: '200': @@ -67930,9 +67989,9 @@ paths: type: integer variables: type: array - items: *474 + items: *475 examples: - default: *475 + default: *476 headers: Link: *45 x-github: @@ -67955,8 +68014,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -68008,17 +68067,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *439 - *440 + - *441 - *286 responses: '200': description: Response content: application/json: - schema: *474 + schema: *475 examples: - default: &607 + default: &608 value: name: USERNAME value: octocat @@ -68044,8 +68103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *439 - *440 + - *441 - *286 requestBody: required: true @@ -68088,8 +68147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *439 - *440 + - *441 - *286 responses: '204': @@ -68115,8 +68174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -68134,7 +68193,7 @@ paths: type: integer workflows: type: array - items: &476 + items: &477 title: Workflow description: A GitHub Actions workflow type: object @@ -68252,9 +68311,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *439 - *440 - - &477 + - *441 + - &478 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -68269,7 +68328,7 @@ paths: description: Response content: application/json: - schema: *476 + schema: *477 examples: default: value: @@ -68302,9 +68361,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *439 - *440 - - *477 + - *441 + - *478 responses: '204': description: Response @@ -68329,9 +68388,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *439 - *440 - - *477 + - *441 + - *478 responses: '204': description: Response @@ -68382,9 +68441,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *439 - *440 - - *477 + - *441 + - *478 responses: '204': description: Response @@ -68411,19 +68470,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *439 - *440 - - *477 + - *441 - *478 - *479 - *480 - *481 + - *482 - *17 - *19 - - *482 - - *461 - *483 + - *462 - *484 + - *485 responses: '200': description: Response @@ -68439,9 +68498,9 @@ paths: type: integer workflow_runs: type: array - items: *462 + items: *463 examples: - default: *485 + default: *486 headers: Link: *45 x-github: @@ -68474,9 +68533,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *439 - *440 - - *477 + - *441 + - *478 responses: '200': description: Response @@ -68537,8 +68596,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *439 - *440 + - *441 - *108 - *17 - *106 @@ -68706,8 +68765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -68744,8 +68803,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *439 - *440 + - *441 - name: assignee in: path required: true @@ -68781,8 +68840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -68894,8 +68953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations parameters: - - *439 - *440 + - *441 - *17 - *106 - *107 @@ -68952,7 +69011,7 @@ paths: initiator: type: string examples: - default: *486 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68972,8 +69031,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -68981,7 +69040,7 @@ paths: application/json: schema: type: array - items: &487 + items: &488 title: Autolink reference description: An autolink reference. type: object @@ -69040,8 +69099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -69080,9 +69139,9 @@ paths: description: response content: application/json: - schema: *487 + schema: *488 examples: - default: &488 + default: &489 value: id: 1 key_prefix: TICKET- @@ -69113,9 +69172,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *439 - *440 - - &489 + - *441 + - &490 name: autolink_id description: The unique identifier of the autolink. in: path @@ -69127,9 +69186,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *488 examples: - default: *488 + default: *489 '404': *6 x-github: githubCloudOnly: false @@ -69149,9 +69208,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *439 - *440 - - *489 + - *441 + - *490 responses: '204': description: Response @@ -69175,8 +69234,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response if Dependabot is enabled @@ -69226,8 +69285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -69248,8 +69307,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -69269,8 +69328,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *439 - *440 + - *441 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -69308,7 +69367,7 @@ paths: - url protected: type: boolean - protection: &491 + protection: &492 title: Branch Protection description: Branch Protection type: object @@ -69351,7 +69410,7 @@ paths: required: - contexts - checks - enforce_admins: &494 + enforce_admins: &495 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -69368,7 +69427,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &496 + required_pull_request_reviews: &497 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -69452,7 +69511,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &493 + restrictions: &494 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -69745,9 +69804,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *439 - *440 - - &492 + - *441 + - &493 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -69761,14 +69820,14 @@ paths: description: Response content: application/json: - schema: &502 + schema: &503 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &553 + commit: &554 title: Commit description: Commit type: object @@ -69807,7 +69866,7 @@ paths: author: anyOf: - type: 'null' - - &490 + - &491 title: Git User description: Metaproperties for Git author/committer information. @@ -69829,7 +69888,7 @@ paths: committer: anyOf: - type: 'null' - - *490 + - *491 message: type: string examples: @@ -69853,7 +69912,7 @@ paths: required: - sha - url - verification: &613 + verification: &614 title: Verification type: object properties: @@ -69933,7 +69992,7 @@ paths: type: integer files: type: array - items: &564 + items: &565 title: Diff Entry description: Diff Entry type: object @@ -70029,7 +70088,7 @@ paths: - self protected: type: boolean - protection: *491 + protection: *492 protection_url: type: string format: uri @@ -70138,7 +70197,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *445 + '301': *446 '404': *6 x-github: githubCloudOnly: false @@ -70160,15 +70219,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *491 + schema: *492 examples: default: value: @@ -70362,9 +70421,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -70624,7 +70683,7 @@ paths: url: type: string format: uri - required_status_checks: &499 + required_status_checks: &500 title: Status Check Policy description: Status Check Policy type: object @@ -70783,7 +70842,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *493 + restrictions: *494 required_conversation_resolution: type: object properties: @@ -70895,9 +70954,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -70922,17 +70981,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *494 + schema: *495 examples: - default: &495 + default: &496 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -70954,17 +71013,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *494 + schema: *495 examples: - default: *495 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70983,9 +71042,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -71010,17 +71069,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *496 + schema: *497 examples: - default: &497 + default: &498 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -71116,9 +71175,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -71216,9 +71275,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *497 examples: - default: *497 + default: *498 '422': *15 x-github: githubCloudOnly: false @@ -71239,9 +71298,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -71268,17 +71327,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *494 + schema: *495 examples: - default: &498 + default: &499 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -71301,17 +71360,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *494 + schema: *495 examples: - default: *498 + default: *499 '404': *6 x-github: githubCloudOnly: false @@ -71331,9 +71390,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -71358,17 +71417,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *499 + schema: *500 examples: - default: &500 + default: &501 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -71394,9 +71453,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -71448,9 +71507,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *500 examples: - default: *500 + default: *501 '404': *6 '422': *15 x-github: @@ -71472,9 +71531,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -71498,9 +71557,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response @@ -71534,9 +71593,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -71603,9 +71662,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -71669,9 +71728,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: content: application/json: @@ -71737,15 +71796,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *493 + schema: *494 examples: default: value: @@ -71836,9 +71895,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -71861,9 +71920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response @@ -71873,7 +71932,7 @@ paths: type: array items: *5 examples: - default: &501 + default: &502 value: - id: 1 slug: octoapp @@ -71930,9 +71989,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -71966,7 +72025,7 @@ paths: type: array items: *5 examples: - default: *501 + default: *502 '422': *15 x-github: githubCloudOnly: false @@ -71987,9 +72046,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72023,7 +72082,7 @@ paths: type: array items: *5 examples: - default: *501 + default: *502 '422': *15 x-github: githubCloudOnly: false @@ -72044,9 +72103,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72080,7 +72139,7 @@ paths: type: array items: *5 examples: - default: *501 + default: *502 '422': *15 x-github: githubCloudOnly: false @@ -72102,9 +72161,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response @@ -72114,7 +72173,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 '404': *6 x-github: githubCloudOnly: false @@ -72134,9 +72193,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -72174,7 +72233,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 '422': *15 x-github: githubCloudOnly: false @@ -72195,9 +72254,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -72235,7 +72294,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 '422': *15 x-github: githubCloudOnly: false @@ -72256,9 +72315,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: content: application/json: @@ -72295,7 +72354,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 '422': *15 x-github: githubCloudOnly: false @@ -72317,9 +72376,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response @@ -72353,9 +72412,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72413,9 +72472,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72473,9 +72532,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72535,9 +72594,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72559,7 +72618,7 @@ paths: description: Response content: application/json: - schema: *502 + schema: *503 examples: default: value: @@ -72673,8 +72732,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *439 - *440 + - *441 - *101 - *102 - *103 @@ -72710,8 +72769,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *439 - *440 + - *441 - name: bypass_request_number in: path required: true @@ -72784,8 +72843,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *439 - *440 + - *441 - *101 - *102 - *103 @@ -72825,8 +72884,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *439 - *440 + - *441 - name: bypass_request_number in: path required: true @@ -72896,8 +72955,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *439 - *440 + - *441 - name: bypass_request_number in: path required: true @@ -72968,8 +73027,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *439 - *440 + - *441 - name: bypass_response_id in: path required: true @@ -73002,8 +73061,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -73282,7 +73341,7 @@ paths: description: Response content: application/json: - schema: &503 + schema: &504 title: CheckRun description: A check performed on the code of a given code change type: object @@ -73705,9 +73764,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *439 - *440 - - &504 + - *441 + - &505 name: check_run_id description: The unique identifier of the check run. in: path @@ -73719,9 +73778,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *504 examples: - default: &505 + default: &506 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -73821,9 +73880,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *439 - *440 - - *504 + - *441 + - *505 requestBody: required: true content: @@ -74063,9 +74122,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *504 examples: - default: *505 + default: *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74085,9 +74144,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *439 - *440 - - *504 + - *441 + - *505 - *17 - *19 responses: @@ -74197,9 +74256,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *439 - *440 - - *504 + - *441 + - *505 responses: '201': description: Response @@ -74243,8 +74302,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -74266,7 +74325,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &507 + schema: &508 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -74364,7 +74423,7 @@ paths: - string - 'null' format: date-time - head_commit: *506 + head_commit: *507 latest_check_runs_count: type: integer check_runs_url: @@ -74392,7 +74451,7 @@ paths: - check_runs_url - pull_requests examples: - default: &508 + default: &509 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -74683,9 +74742,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *507 + schema: *508 examples: - default: *508 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74704,8 +74763,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -75014,9 +75073,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *439 - *440 - - &509 + - *441 + - &510 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -75028,9 +75087,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: *508 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75053,17 +75112,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *439 - *440 - - *509 - - &559 + - *441 + - *510 + - &560 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &560 + - &561 name: status description: Returns check runs with the specified `status`. in: query @@ -75102,9 +75161,9 @@ paths: type: integer check_runs: type: array - items: *503 + items: *504 examples: - default: &561 + default: &562 value: total_count: 1 check_runs: @@ -75206,9 +75265,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *439 - *440 - - *509 + - *441 + - *510 responses: '201': description: Response @@ -75241,21 +75300,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *439 - *440 + - *441 - *306 - *307 - *19 - *17 - - &525 + - &526 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *510 - - &526 + schema: *511 + - &527 name: pr description: The number of the pull request for the results you want to list. in: query @@ -75286,7 +75345,7 @@ paths: be returned. in: query required: false - schema: *511 + schema: *512 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -75310,7 +75369,7 @@ paths: updated_at: *132 url: *129 html_url: *130 - instances_url: *512 + instances_url: *513 state: *111 fixed_at: *134 dismissed_by: @@ -75318,11 +75377,11 @@ paths: - type: 'null' - *4 dismissed_at: *133 - dismissed_reason: *513 - dismissed_comment: *514 - rule: *515 - tool: *516 - most_recent_instance: *517 + dismissed_reason: *514 + dismissed_comment: *515 + rule: *516 + tool: *517 + most_recent_instance: *518 dismissal_approved_by: anyOf: - type: 'null' @@ -75445,7 +75504,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &518 + '403': &519 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -75472,9 +75531,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *439 - *440 - - &519 + - *441 + - &520 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -75488,7 +75547,7 @@ paths: description: Response content: application/json: - schema: &520 + schema: &521 type: object properties: number: *124 @@ -75496,7 +75555,7 @@ paths: updated_at: *132 url: *129 html_url: *130 - instances_url: *512 + instances_url: *513 state: *111 fixed_at: *134 dismissed_by: @@ -75504,8 +75563,8 @@ paths: - type: 'null' - *4 dismissed_at: *133 - dismissed_reason: *513 - dismissed_comment: *514 + dismissed_reason: *514 + dismissed_comment: *515 rule: type: object properties: @@ -75567,8 +75626,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *516 - most_recent_instance: *517 + tool: *517 + most_recent_instance: *518 dismissal_approved_by: anyOf: - type: 'null' @@ -75664,7 +75723,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -75684,9 +75743,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 requestBody: required: true content: @@ -75701,8 +75760,8 @@ paths: enum: - open - dismissed - dismissed_reason: *513 - dismissed_comment: *514 + dismissed_reason: *514 + dismissed_comment: *515 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -75730,7 +75789,7 @@ paths: description: Response content: application/json: - schema: *520 + schema: *521 examples: default: value: @@ -75806,7 +75865,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &524 + '403': &525 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -75833,15 +75892,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 responses: '200': description: Response content: application/json: - schema: &521 + schema: &522 type: object properties: status: @@ -75868,13 +75927,13 @@ paths: - description - started_at examples: - default: &522 + default: &523 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &523 + '400': &524 description: Bad Request content: application/json: @@ -75885,7 +75944,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -75910,29 +75969,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 responses: '200': description: OK content: application/json: - schema: *521 + schema: *522 examples: - default: *522 + default: *523 '202': description: Accepted content: application/json: - schema: *521 + schema: *522 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *523 + '400': *524 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -75964,9 +76023,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 requestBody: required: false content: @@ -76012,8 +76071,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *523 - '403': *524 + '400': *524 + '403': *525 '404': *6 '422': description: Unprocessable Entity @@ -76037,13 +76096,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 - *19 - *17 - - *525 - *526 + - *527 responses: '200': description: Response @@ -76054,10 +76113,10 @@ paths: items: type: object properties: - ref: *510 - analysis_key: *527 - environment: *528 - category: *529 + ref: *511 + analysis_key: *528 + environment: *529 + category: *530 state: type: - string @@ -76074,7 +76133,7 @@ paths: properties: text: type: string - location: *530 + location: *531 html_url: type: string classifications: @@ -76082,7 +76141,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *531 + items: *532 examples: default: value: @@ -76121,7 +76180,7 @@ paths: end_column: 50 classifications: - source - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -76155,25 +76214,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *439 - *440 + - *441 - *306 - *307 - *19 - *17 - - *526 + - *527 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *510 + schema: *511 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &532 + schema: &533 type: string description: An identifier for the upload. examples: @@ -76195,23 +76254,23 @@ paths: application/json: schema: type: array - items: &533 + items: &534 type: object properties: - ref: *510 - commit_sha: &541 + ref: *511 + commit_sha: &542 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *527 + analysis_key: *528 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *529 + category: *530 error: type: string examples: @@ -76236,8 +76295,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *532 - tool: *516 + sarif_id: *533 + tool: *517 deletable: type: boolean warning: @@ -76299,7 +76358,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -76335,8 +76394,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *439 - *440 + - *441 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -76349,7 +76408,7 @@ paths: description: Response content: application/json: - schema: *533 + schema: *534 examples: response: summary: application/json response @@ -76403,7 +76462,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *518 + '403': *519 '404': *6 '422': description: Response if analysis could not be processed @@ -76490,8 +76549,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *439 - *440 + - *441 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -76547,7 +76606,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *524 + '403': *525 '404': *6 '503': *190 x-github: @@ -76569,8 +76628,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -76578,7 +76637,7 @@ paths: application/json: schema: type: array - items: &534 + items: &535 title: CodeQL Database description: A CodeQL database. type: object @@ -76690,7 +76749,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -76719,8 +76778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *439 - *440 + - *441 - name: language in: path description: The language of the CodeQL database. @@ -76732,7 +76791,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *535 examples: default: value: @@ -76764,9 +76823,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &566 + '302': &567 description: Found - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -76788,8 +76847,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *439 - *440 + - *441 - name: language in: path description: The language of the CodeQL database. @@ -76799,7 +76858,7 @@ paths: responses: '204': description: Response - '403': *524 + '403': *525 '404': *6 '503': *190 x-github: @@ -76827,8 +76886,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -76837,7 +76896,7 @@ paths: type: object additionalProperties: false properties: - language: &535 + language: &536 type: string description: The language targeted by the CodeQL query enum: @@ -76917,7 +76976,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &539 + schema: &540 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -76927,7 +76986,7 @@ paths: description: The ID of the variant analysis. controller_repo: *118 actor: *4 - query_language: *535 + query_language: *536 query_pack_url: type: string description: The download url for the query pack. @@ -76975,7 +77034,7 @@ paths: items: type: object properties: - repository: &536 + repository: &537 title: Repository Identifier description: Repository Identifier type: object @@ -77017,7 +77076,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &540 + analysis_status: &541 type: string description: The new status of the CodeQL variant analysis repository task. @@ -77049,7 +77108,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &537 + access_mismatch_repos: &538 type: object properties: repository_count: @@ -77064,7 +77123,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *536 + items: *537 required: - repository_count - repositories @@ -77087,8 +77146,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *537 - over_limit_repos: *537 + no_codeql_db_repos: *538 + over_limit_repos: *538 required: - access_mismatch_repos - not_found_repos @@ -77104,7 +77163,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &538 + value: &539 summary: Default response value: id: 1 @@ -77250,10 +77309,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *538 + value: *539 repository_lists: summary: Response for a successful variant analysis submission - value: *538 + value: *539 '404': *6 '422': description: Unable to process variant analysis submission @@ -77281,8 +77340,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *439 - *440 + - *441 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -77294,9 +77353,9 @@ paths: description: Response content: application/json: - schema: *539 + schema: *540 examples: - default: *538 + default: *539 '404': *6 '503': *190 x-github: @@ -77319,7 +77378,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *439 + - *440 - name: repo in: path description: The name of the controller repository. @@ -77354,7 +77413,7 @@ paths: type: object properties: repository: *118 - analysis_status: *540 + analysis_status: *541 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -77479,8 +77538,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -77573,7 +77632,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -77594,8 +77653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -77689,7 +77748,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *524 + '403': *525 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -77760,8 +77819,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -77769,7 +77828,7 @@ paths: schema: type: object properties: - commit_sha: *541 + commit_sha: *542 ref: type: string description: |- @@ -77829,7 +77888,7 @@ paths: schema: type: object properties: - id: *532 + id: *533 url: type: string description: The REST API URL for checking the status of the upload. @@ -77843,7 +77902,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *524 + '403': *525 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -77866,8 +77925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *439 - *440 + - *441 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -77915,7 +77974,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *518 + '403': *519 '404': description: Not Found if the sarif id does not match any upload '503': *190 @@ -77940,8 +77999,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -78022,8 +78081,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *439 - *440 + - *441 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -78151,8 +78210,8 @@ paths: parameters: - *17 - *19 - - *439 - *440 + - *441 responses: '200': description: Response @@ -78168,7 +78227,7 @@ paths: type: integer codespaces: type: array - items: *363 + items: *364 examples: default: value: @@ -78466,8 +78525,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -78531,17 +78590,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '400': *14 '401': *23 '403': *27 @@ -78570,8 +78629,8 @@ paths: parameters: - *17 - *19 - - *439 - *440 + - *441 responses: '200': description: Response @@ -78635,8 +78694,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *439 - *440 + - *441 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -78673,7 +78732,7 @@ paths: type: integer machines: type: array - items: *543 + items: *544 examples: default: &779 value: @@ -78715,8 +78774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *439 - *440 + - *441 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -78803,8 +78862,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *439 - *440 + - *441 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -78873,8 +78932,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -78892,7 +78951,7 @@ paths: type: integer secrets: type: array - items: &547 + items: &548 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -78913,7 +78972,7 @@ paths: - created_at - updated_at examples: - default: *544 + default: *545 headers: Link: *45 x-github: @@ -78936,16 +78995,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: *545 + schema: *546 examples: - default: *546 + default: *547 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -78965,17 +79024,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '200': description: Response content: application/json: - schema: *547 + schema: *548 examples: - default: *548 + default: *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78995,8 +79054,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 requestBody: required: true @@ -79049,8 +79108,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '204': @@ -79079,8 +79138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *439 - *440 + - *441 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -79118,7 +79177,7 @@ paths: application/json: schema: type: array - items: &549 + items: &550 title: Collaborator description: Collaborator type: object @@ -79311,8 +79370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *439 - *440 + - *441 - *137 responses: '204': @@ -79359,8 +79418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *439 - *440 + - *441 - *137 requestBody: required: false @@ -79615,8 +79674,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *439 - *440 + - *441 - *137 responses: '204': @@ -79648,8 +79707,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *439 - *440 + - *441 - *137 responses: '200': @@ -79670,7 +79729,7 @@ paths: user: anyOf: - type: 'null' - - *549 + - *550 required: - permission - role_name @@ -79724,8 +79783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -79735,7 +79794,7 @@ paths: application/json: schema: type: array - items: &550 + items: &551 title: Commit Comment description: Commit Comment type: object @@ -79793,7 +79852,7 @@ paths: - created_at - updated_at examples: - default: &555 + default: &556 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79852,17 +79911,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *439 - *440 + - *441 - *228 responses: '200': description: Response content: application/json: - schema: *550 + schema: *551 examples: - default: &556 + default: &557 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79919,8 +79978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -79943,7 +80002,7 @@ paths: description: Response content: application/json: - schema: *550 + schema: *551 examples: default: value: @@ -79994,8 +80053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *439 - *440 + - *441 - *228 responses: '204': @@ -80017,8 +80076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *439 - *440 + - *441 - *228 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -80045,7 +80104,7 @@ paths: application/json: schema: type: array - items: &551 + items: &552 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -80134,8 +80193,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -80168,9 +80227,9 @@ paths: description: Reaction exists content: application/json: - schema: *551 + schema: *552 examples: - default: &552 + default: &553 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -80199,9 +80258,9 @@ paths: description: Reaction created content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '422': *15 x-github: githubCloudOnly: false @@ -80223,8 +80282,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *439 - *440 + - *441 - *228 - &631 name: reaction_id @@ -80281,8 +80340,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *439 - *440 + - *441 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -80338,7 +80397,7 @@ paths: application/json: schema: type: array - items: *553 + items: *554 examples: default: &677 value: @@ -80434,9 +80493,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *439 - *440 - - &554 + - *441 + - &555 name: commit_sha description: The SHA of the commit. in: path @@ -80508,9 +80567,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *439 - *440 - - *554 + - *441 + - *555 - *17 - *19 responses: @@ -80520,9 +80579,9 @@ paths: application/json: schema: type: array - items: *550 + items: *551 examples: - default: *555 + default: *556 headers: Link: *45 x-github: @@ -80550,9 +80609,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *439 - *440 - - *554 + - *441 + - *555 requestBody: required: true content: @@ -80587,9 +80646,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *551 examples: - default: *556 + default: *557 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -80617,9 +80676,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *439 - *440 - - *554 + - *441 + - *555 - *17 - *19 responses: @@ -80629,7 +80688,7 @@ paths: application/json: schema: type: array - items: *557 + items: *558 examples: default: &669 value: @@ -81168,11 +81227,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *439 - *440 + - *441 - *19 - *17 - - &558 + - &559 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -81187,7 +81246,7 @@ paths: description: Response content: application/json: - schema: *553 + schema: *554 examples: default: &655 value: @@ -81302,11 +81361,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *439 - *440 - - *558 + - *441 - *559 - *560 + - *561 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -81340,9 +81399,9 @@ paths: type: integer check_runs: type: array - items: *503 + items: *504 examples: - default: *561 + default: *562 headers: Link: *45 x-github: @@ -81367,9 +81426,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *439 - *440 - - *558 + - *441 + - *559 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -81377,7 +81436,7 @@ paths: schema: type: integer example: 1 - - *559 + - *560 - *17 - *19 responses: @@ -81395,7 +81454,7 @@ paths: type: integer check_suites: type: array - items: *507 + items: *508 examples: default: value: @@ -81595,9 +81654,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *439 - *440 - - *558 + - *441 + - *559 - *17 - *19 responses: @@ -81799,9 +81858,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *439 - *440 - - *558 + - *441 + - *559 - *17 - *19 responses: @@ -81892,7 +81951,7 @@ paths: site_admin: false headers: Link: *45 - '301': *445 + '301': *446 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81920,8 +81979,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -81954,11 +82013,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *562 + - *563 code_of_conduct_file: anyOf: - type: 'null' - - &563 + - &564 title: Community Health File type: object properties: @@ -81978,19 +82037,19 @@ paths: contributing: anyOf: - type: 'null' - - *563 + - *564 readme: anyOf: - type: 'null' - - *563 + - *564 issue_template: anyOf: - type: 'null' - - *563 + - *564 pull_request_template: anyOf: - type: 'null' - - *563 + - *564 required: - code_of_conduct - code_of_conduct_file @@ -82119,8 +82178,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *439 - *440 + - *441 - *19 - *17 - name: basehead @@ -82168,8 +82227,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *553 - merge_base_commit: *553 + base_commit: *554 + merge_base_commit: *554 status: type: string enum: @@ -82193,10 +82252,10 @@ paths: - 6 commits: type: array - items: *553 + items: *554 files: type: array - items: *564 + items: *565 required: - url - html_url @@ -82482,8 +82541,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *439 - *440 + - *441 - name: path description: path parameter in: path @@ -82636,7 +82695,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &565 + response-if-content-is-a-file: &566 summary: Response if content is a file value: type: file @@ -82991,7 +83050,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *565 + response-if-content-is-a-file: *566 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -83060,7 +83119,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *566 + '302': *567 '304': *35 x-github: githubCloudOnly: false @@ -83083,8 +83142,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *439 - *440 + - *441 - name: path description: path parameter in: path @@ -83179,7 +83238,7 @@ paths: description: Response content: application/json: - schema: &567 + schema: &568 title: File Commit description: File Commit type: object @@ -83335,7 +83394,7 @@ paths: description: Response content: application/json: - schema: *567 + schema: *568 examples: example-for-creating-a-file: value: @@ -83389,7 +83448,7 @@ paths: schema: oneOf: - *3 - - &608 + - &609 description: Repository rule violation was detected type: object properties: @@ -83442,8 +83501,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *439 - *440 + - *441 - name: path description: path parameter in: path @@ -83504,7 +83563,7 @@ paths: description: Response content: application/json: - schema: *567 + schema: *568 examples: default: value: @@ -83559,8 +83618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *439 - *440 + - *441 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -83684,8 +83743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *439 - *440 + - *441 - *321 - *322 - *323 @@ -83697,7 +83756,7 @@ paths: schema: type: string - *325 - - *568 + - *569 - *326 - *327 - *108 @@ -83718,7 +83777,7 @@ paths: application/json: schema: type: array - items: &572 + items: &573 type: object description: A Dependabot alert. properties: @@ -83768,7 +83827,7 @@ paths: - direct - transitive - - security_advisory: *569 + security_advisory: *570 security_vulnerability: *128 url: *129 html_url: *130 @@ -83799,8 +83858,8 @@ paths: dismissal. maxLength: 280 fixed_at: *134 - auto_dismissed_at: *570 - dismissal_request: *571 + auto_dismissed_at: *571 + dismissal_request: *572 required: - number - state @@ -84030,9 +84089,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *439 - *440 - - &573 + - *441 + - &574 name: alert_number in: path description: |- @@ -84047,7 +84106,7 @@ paths: description: Response content: application/json: - schema: *572 + schema: *573 examples: default: value: @@ -84160,9 +84219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *439 - *440 - - *573 + - *441 + - *574 requestBody: required: true content: @@ -84207,7 +84266,7 @@ paths: description: Response content: application/json: - schema: *572 + schema: *573 examples: default: value: @@ -84336,8 +84395,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -84355,7 +84414,7 @@ paths: type: integer secrets: type: array - items: &576 + items: &577 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -84409,16 +84468,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: *574 + schema: *575 examples: - default: *575 + default: *576 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84438,15 +84497,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '200': description: Response content: application/json: - schema: *576 + schema: *577 examples: default: value: @@ -84472,8 +84531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 requestBody: required: true @@ -84526,8 +84585,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '204': @@ -84550,8 +84609,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *439 - *440 + - *441 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -84725,8 +84784,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -84986,8 +85045,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -85070,7 +85129,7 @@ paths: - version - url additionalProperties: false - metadata: &577 + metadata: &578 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -85109,7 +85168,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *577 + metadata: *578 resolved: type: object description: A collection of resolved package dependencies. @@ -85123,7 +85182,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *577 + metadata: *578 relationship: type: string description: A notation of whether a dependency is requested @@ -85256,8 +85315,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *439 - *440 + - *441 - name: sha description: The SHA recorded at creation time. in: query @@ -85298,9 +85357,9 @@ paths: application/json: schema: type: array - items: *578 + items: *579 examples: - default: *579 + default: *580 headers: Link: *45 x-github: @@ -85366,8 +85425,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -85449,7 +85508,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *579 examples: simple-example: summary: Simple example @@ -85522,9 +85581,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *439 - *440 - - &580 + - *441 + - &581 name: deployment_id description: deployment_id parameter in: path @@ -85536,7 +85595,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *579 examples: default: value: @@ -85601,9 +85660,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *439 - *440 - - *580 + - *441 + - *581 responses: '204': description: Response @@ -85625,9 +85684,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *439 - *440 - - *580 + - *441 + - *581 - *17 - *19 responses: @@ -85637,7 +85696,7 @@ paths: application/json: schema: type: array - items: &581 + items: &582 title: Deployment Status description: The status of a deployment. type: object @@ -85801,9 +85860,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *439 - *440 - - *580 + - *441 + - *581 requestBody: required: true content: @@ -85878,9 +85937,9 @@ paths: description: Response content: application/json: - schema: *581 + schema: *582 examples: - default: &582 + default: &583 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -85936,9 +85995,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *439 - *440 - - *580 + - *441 + - *581 - name: status_id in: path required: true @@ -85949,9 +86008,9 @@ paths: description: Response content: application/json: - schema: *581 + schema: *582 examples: - default: *582 + default: *583 '404': *6 x-github: githubCloudOnly: false @@ -85978,12 +86037,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 - - *583 + - *441 - *584 - *585 - *586 + - *587 - *17 - *19 responses: @@ -85993,9 +86052,9 @@ paths: application/json: schema: type: array - items: *587 + items: *588 examples: - default: *588 + default: *589 '404': *6 '403': *27 '500': *38 @@ -86019,8 +86078,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86032,7 +86091,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *587 + schema: *588 examples: default: value: @@ -86088,8 +86147,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86148,12 +86207,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *439 - *440 - - *583 + - *441 - *584 - *585 - *586 + - *587 - *17 - *19 responses: @@ -86163,9 +86222,9 @@ paths: application/json: schema: type: array - items: *589 + items: *590 examples: - default: *590 + default: *591 '404': *6 '403': *27 '500': *38 @@ -86189,8 +86248,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86202,7 +86261,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *589 + schema: *590 examples: default: value: @@ -86253,8 +86312,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86292,7 +86351,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *589 + schema: *590 examples: default: value: @@ -86343,8 +86402,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86415,8 +86474,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86449,8 +86508,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - *101 - *102 - *103 @@ -86464,9 +86523,9 @@ paths: application/json: schema: type: array - items: *591 + items: *592 examples: - default: *592 + default: *593 '404': *6 '403': *27 '500': *38 @@ -86491,8 +86550,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86504,7 +86563,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *591 + schema: *592 examples: default: value: @@ -86562,8 +86621,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86632,8 +86691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -86690,8 +86749,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -86709,7 +86768,7 @@ paths: - 5 environments: type: array - items: &594 + items: &595 title: Environment description: Details of a deployment environment type: object @@ -86771,7 +86830,7 @@ paths: type: string examples: - wait_timer - wait_timer: &596 + wait_timer: &597 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -86813,7 +86872,7 @@ paths: items: type: object properties: - type: *593 + type: *594 reviewer: anyOf: - *4 @@ -86840,7 +86899,7 @@ paths: - id - node_id - type - deployment_branch_policy: &597 + deployment_branch_policy: &598 type: - object - 'null' @@ -86957,9 +87016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *439 - *440 - - &595 + - *441 + - &596 name: environment_name in: path required: true @@ -86972,9 +87031,9 @@ paths: description: Response content: application/json: - schema: *594 + schema: *595 examples: - default: &598 + default: &599 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -87058,9 +87117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *439 - *440 - - *595 + - *441 + - *596 requestBody: required: false content: @@ -87070,7 +87129,7 @@ paths: - object - 'null' properties: - wait_timer: *596 + wait_timer: *597 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -87089,14 +87148,14 @@ paths: items: type: object properties: - type: *593 + type: *594 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *597 + deployment_branch_policy: *598 additionalProperties: false examples: default: @@ -87116,9 +87175,9 @@ paths: description: Response content: application/json: - schema: *594 + schema: *595 examples: - default: *598 + default: *599 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -87142,9 +87201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *439 - *440 - - *595 + - *441 + - *596 responses: '204': description: Default response @@ -87169,9 +87228,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *17 - *19 responses: @@ -87190,7 +87249,7 @@ paths: - 2 branch_policies: type: array - items: &599 + items: &600 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -87251,9 +87310,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *439 - *440 - - *595 + - *441 + - *596 requestBody: required: true content: @@ -87301,9 +87360,9 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: - example-wildcard: &600 + example-wildcard: &601 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -87345,10 +87404,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *439 - *440 - - *595 - - &601 + - *441 + - *596 + - &602 name: branch_policy_id in: path required: true @@ -87360,9 +87419,9 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87381,10 +87440,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *439 - *440 - - *595 - - *601 + - *441 + - *596 + - *602 requestBody: required: true content: @@ -87413,9 +87472,9 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87434,10 +87493,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *439 - *440 - - *595 - - *601 + - *441 + - *596 + - *602 responses: '204': description: Response @@ -87462,9 +87521,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *595 + - *596 + - *441 - *440 - - *439 responses: '200': description: List of deployment protection rules @@ -87481,7 +87540,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &602 + items: &603 title: Deployment protection rule description: Deployment protection rule type: object @@ -87503,7 +87562,7 @@ paths: for the environment. examples: - true - app: &603 + app: &604 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -87606,9 +87665,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *595 + - *596 + - *441 - *440 - - *439 requestBody: content: application/json: @@ -87629,9 +87688,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *602 + schema: *603 examples: - default: &604 + default: &605 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -87666,9 +87725,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *595 + - *596 + - *441 - *440 - - *439 - *19 - *17 responses: @@ -87688,7 +87747,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *603 + items: *604 examples: default: value: @@ -87723,10 +87782,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *439 - *440 - - *595 - - &605 + - *441 + - *596 + - &606 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -87738,9 +87797,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *603 examples: - default: *604 + default: *605 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87761,10 +87820,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *595 + - *596 + - *441 - *440 - - *439 - - *605 + - *606 responses: '204': description: Response @@ -87790,9 +87849,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *17 - *19 responses: @@ -87810,9 +87869,9 @@ paths: type: integer secrets: type: array - items: *470 + items: *471 examples: - default: *471 + default: *472 headers: Link: *45 x-github: @@ -87837,17 +87896,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *439 - *440 - - *595 + - *441 + - *596 responses: '200': description: Response content: application/json: - schema: *472 + schema: *473 examples: - default: *473 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87869,18 +87928,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *283 responses: '200': description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *606 + default: *607 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87902,9 +87961,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *283 requestBody: required: true @@ -87962,9 +88021,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *283 responses: '204': @@ -87990,10 +88049,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *439 - *440 - - *595 - - *457 + - *441 + - *596 + - *458 - *19 responses: '200': @@ -88010,9 +88069,9 @@ paths: type: integer variables: type: array - items: *474 + items: *475 examples: - default: *475 + default: *476 headers: Link: *45 x-github: @@ -88035,9 +88094,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *439 - *440 - - *595 + - *441 + - *596 requestBody: required: true content: @@ -88089,18 +88148,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *286 responses: '200': description: Response content: application/json: - schema: *474 + schema: *475 examples: - default: *607 + default: *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88121,10 +88180,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *439 - *440 + - *441 - *286 - - *595 + - *596 requestBody: required: true content: @@ -88166,10 +88225,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *439 - *440 + - *441 - *286 - - *595 + - *596 responses: '204': description: Response @@ -88191,8 +88250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -88260,8 +88319,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *439 - *440 + - *441 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -88420,8 +88479,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -88454,9 +88513,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *445 examples: - default: *446 + default: *447 '400': *14 '422': *15 '403': *27 @@ -88477,8 +88536,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -88538,7 +88597,7 @@ paths: schema: oneOf: - *248 - - *608 + - *609 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88563,8 +88622,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *439 - *440 + - *441 - name: file_sha in: path required: true @@ -88664,8 +88723,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -88774,7 +88833,7 @@ paths: description: Response content: application/json: - schema: &609 + schema: &610 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -89001,15 +89060,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *439 - *440 - - *554 + - *441 + - *555 responses: '200': description: Response content: application/json: - schema: *609 + schema: *610 examples: default: value: @@ -89065,9 +89124,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *439 - *440 - - &610 + - *441 + - &611 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -89084,7 +89143,7 @@ paths: application/json: schema: type: array - items: &611 + items: &612 title: Git Reference description: Git references within a repository type: object @@ -89160,17 +89219,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *439 - *440 - - *610 + - *441 + - *611 responses: '200': description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: &612 + default: &613 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -89199,8 +89258,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -89229,9 +89288,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *612 + default: *613 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -89257,9 +89316,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *439 - *440 - - *610 + - *441 + - *611 requestBody: required: true content: @@ -89288,9 +89347,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *612 + default: *613 '422': *15 '409': *117 x-github: @@ -89308,9 +89367,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *439 - *440 - - *610 + - *441 + - *611 responses: '204': description: Response @@ -89365,8 +89424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -89433,7 +89492,7 @@ paths: description: Response content: application/json: - schema: &614 + schema: &615 title: Git Tag description: Metadata for a Git tag type: object @@ -89489,7 +89548,7 @@ paths: - sha - type - url - verification: *613 + verification: *614 required: - sha - url @@ -89499,7 +89558,7 @@ paths: - tag - message examples: - default: &615 + default: &616 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -89572,8 +89631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *439 - *440 + - *441 - name: tag_sha in: path required: true @@ -89584,9 +89643,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: *615 + default: *616 '404': *6 '409': *117 x-github: @@ -89610,8 +89669,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -89685,7 +89744,7 @@ paths: description: Response content: application/json: - schema: &616 + schema: &617 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -89787,8 +89846,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *439 - *440 + - *441 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -89811,7 +89870,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *617 examples: default-response: summary: Default response @@ -89870,8 +89929,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -89881,7 +89940,7 @@ paths: application/json: schema: type: array - items: &617 + items: &618 title: Webhook description: Webhooks for repositories. type: object @@ -90021,8 +90080,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -90075,9 +90134,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *618 examples: - default: &618 + default: &619 value: type: Repository id: 12345678 @@ -90125,17 +90184,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 responses: '200': description: Response content: application/json: - schema: *617 + schema: *618 examples: - default: *618 + default: *619 '404': *6 x-github: githubCloudOnly: false @@ -90155,8 +90214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 requestBody: required: true @@ -90202,9 +90261,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *618 examples: - default: *618 + default: *619 '422': *15 '404': *6 x-github: @@ -90225,8 +90284,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 responses: '204': @@ -90251,8 +90310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *439 - *440 + - *441 - *335 responses: '200': @@ -90280,8 +90339,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *439 - *440 + - *441 - *335 requestBody: required: false @@ -90326,8 +90385,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 - *17 - *336 @@ -90359,8 +90418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 - *16 responses: @@ -90389,8 +90448,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 - *16 responses: @@ -90414,8 +90473,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 responses: '204': @@ -90441,8 +90500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *439 - *440 + - *441 - *335 responses: '204': @@ -90466,8 +90525,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response if immutable releases are enabled @@ -90515,8 +90574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *439 - *440 + - *441 responses: '204': *149 '409': *117 @@ -90536,8 +90595,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *439 - *440 + - *441 responses: '204': *149 '409': *117 @@ -90594,14 +90653,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: &619 + schema: &620 title: Import description: A repository import from an external source. type: object @@ -90708,7 +90767,7 @@ paths: - html_url - authors_url examples: - default: &622 + default: &623 value: vcs: subversion use_lfs: true @@ -90724,7 +90783,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &620 + '503': &621 description: Unavailable due to service under maintenance. content: application/json: @@ -90753,8 +90812,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -90802,7 +90861,7 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: default: value: @@ -90827,7 +90886,7 @@ paths: type: string '422': *15 '404': *6 - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90855,8 +90914,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -90908,7 +90967,7 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: example-1: summary: Example 1 @@ -90956,7 +91015,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90979,12 +91038,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *439 - *440 + - *441 responses: '204': description: Response - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91010,8 +91069,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *439 - *440 + - *441 - &800 name: since description: A user ID. Only return users with an ID greater than this ID. @@ -91026,7 +91085,7 @@ paths: application/json: schema: type: array - items: &621 + items: &622 title: Porter Author description: Porter Author type: object @@ -91080,7 +91139,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91105,8 +91164,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *439 - *440 + - *441 - name: author_id in: path required: true @@ -91136,7 +91195,7 @@ paths: description: Response content: application/json: - schema: *621 + schema: *622 examples: default: value: @@ -91149,7 +91208,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91173,8 +91232,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -91215,7 +91274,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91243,8 +91302,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -91271,11 +91330,11 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: - default: *622 + default: *623 '422': *15 - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91298,8 +91357,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -91307,8 +91366,8 @@ paths: application/json: schema: *20 examples: - default: *623 - '301': *445 + default: *352 + '301': *446 '404': *6 x-github: githubCloudOnly: false @@ -91328,8 +91387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -91337,7 +91396,7 @@ paths: application/json: schema: anyOf: - - *353 + - *354 - type: object properties: {} additionalProperties: false @@ -91367,8 +91426,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -91385,7 +91444,7 @@ paths: description: Response content: application/json: - schema: *353 + schema: *354 examples: default: *625 '409': @@ -91409,8 +91468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -91433,8 +91492,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -91577,9 +91636,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *439 - *440 - - *357 + - *441 + - *358 requestBody: required: false content: @@ -91739,9 +91798,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *439 - *440 - - *357 + - *441 + - *358 responses: '204': description: Response @@ -91772,8 +91831,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *439 - *440 + - *441 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -91821,7 +91880,7 @@ paths: required: false schema: type: string - - *361 + - *362 - name: sort description: What to sort results by. in: query @@ -91994,7 +92053,7 @@ paths: state_reason: completed headers: Link: *45 - '301': *445 + '301': *446 '422': *15 '404': *6 x-github: @@ -92023,8 +92082,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -92300,8 +92359,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *439 - *440 + - *441 - *236 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -92382,8 +92441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *439 - *440 + - *441 - *228 responses: '200': @@ -92446,8 +92505,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -92490,8 +92549,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *439 - *440 + - *441 - *228 responses: '204': @@ -92512,8 +92571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *439 - *440 + - *441 - *228 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -92540,7 +92599,7 @@ paths: application/json: schema: type: array - items: *551 + items: *552 examples: default: *630 headers: @@ -92563,8 +92622,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -92597,16 +92656,16 @@ paths: description: Reaction exists content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '201': description: Reaction created content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '422': *15 x-github: githubCloudOnly: false @@ -92628,8 +92687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *439 - *440 + - *441 - *228 - *631 responses: @@ -92651,8 +92710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -93001,8 +93060,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *439 - *440 + - *441 - name: event_id in: path required: true @@ -93239,8 +93298,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *439 - *440 + - *441 - &634 name: issue_number description: The number that identifies the issue. @@ -93256,7 +93315,7 @@ paths: schema: *213 examples: default: *633 - '301': *445 + '301': *446 '404': *6 '410': *627 '304': *35 @@ -93283,8 +93342,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: false @@ -93410,7 +93469,7 @@ paths: '422': *15 '503': *190 '403': *27 - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -93430,8 +93489,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: false @@ -93476,8 +93535,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: content: @@ -93527,8 +93586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *439 - *440 + - *441 - *634 - name: assignee in: path @@ -93569,8 +93628,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *439 - *440 + - *441 - *634 - *219 - *17 @@ -93617,8 +93676,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -93678,8 +93737,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -93695,7 +93754,7 @@ paths: default: *636 headers: Link: *45 - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -93725,8 +93784,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -93757,7 +93816,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *445 + '301': *446 '403': *27 '410': *627 '422': *15 @@ -93790,8 +93849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *439 - *440 + - *441 - *634 - name: issue_id in: path @@ -93807,7 +93866,7 @@ paths: schema: *213 examples: default: *633 - '301': *445 + '301': *446 '400': *14 '401': *23 '403': *27 @@ -93838,8 +93897,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -93855,7 +93914,7 @@ paths: default: *636 headers: Link: *45 - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -93874,8 +93933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -94686,8 +94745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -94718,7 +94777,7 @@ paths: default: false headers: Link: *45 - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -94737,8 +94796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: false @@ -94801,7 +94860,7 @@ paths: items: *212 examples: default: *637 - '301': *445 + '301': *446 '404': *6 '410': *627 '422': *15 @@ -94820,8 +94879,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: false @@ -94885,7 +94944,7 @@ paths: items: *212 examples: default: *637 - '301': *445 + '301': *446 '404': *6 '410': *627 '422': *15 @@ -94904,13 +94963,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *439 - *440 + - *441 - *634 responses: '204': description: Response - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -94931,8 +94990,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *439 - *440 + - *441 - *634 - name: name in: path @@ -94957,7 +95016,7 @@ paths: description: Something isn't working color: f29513 default: true - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -94979,8 +95038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: false @@ -95028,8 +95087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *439 - *440 + - *441 - *634 responses: '204': @@ -95060,8 +95119,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *439 - *440 + - *441 - *634 responses: '200': @@ -95071,7 +95130,7 @@ paths: schema: *213 examples: default: *633 - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -95090,8 +95149,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *439 - *440 + - *441 - *634 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -95118,7 +95177,7 @@ paths: application/json: schema: type: array - items: *551 + items: *552 examples: default: *630 headers: @@ -95142,8 +95201,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -95176,16 +95235,16 @@ paths: description: Response content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '201': description: Response content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '422': *15 x-github: githubCloudOnly: false @@ -95207,8 +95266,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *439 - *440 + - *441 - *634 - *631 responses: @@ -95239,8 +95298,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -95298,8 +95357,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -95344,8 +95403,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -95402,8 +95461,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -95459,8 +95518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -95542,6 +95601,9 @@ paths: - type: 'null' - *5 reactions: *215 + pin: + anyOf: + - type: 'null' required: - event - actor @@ -96058,7 +96120,7 @@ paths: type: string comments: type: array - items: *550 + items: *551 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -96350,8 +96412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -96429,8 +96491,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -96502,8 +96564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *439 - *440 + - *441 - &653 name: key_id description: The unique identifier of the key. @@ -96536,8 +96598,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *439 - *440 + - *441 - *653 responses: '204': @@ -96558,8 +96620,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -96592,8 +96654,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -96663,8 +96725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *439 - *440 + - *441 - name: name in: path required: true @@ -96694,8 +96756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *439 - *440 + - *441 - name: name in: path required: true @@ -96760,8 +96822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *439 - *440 + - *441 - name: name in: path required: true @@ -96787,8 +96849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -96824,8 +96886,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *439 - *440 + - *441 responses: '202': *37 '403': @@ -96853,8 +96915,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -96880,9 +96942,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *439 - *440 - - *525 + - *441 + - *526 responses: '200': description: Response @@ -97029,8 +97091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -97095,8 +97157,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -97130,7 +97192,7 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *553 + schema: *554 examples: default: *655 '204': @@ -97157,8 +97219,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *439 - *440 + - *441 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -97199,7 +97261,7 @@ paths: application/json: schema: type: array - items: *392 + items: *393 examples: default: value: @@ -97255,8 +97317,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -97296,7 +97358,7 @@ paths: description: Response content: application/json: - schema: *392 + schema: *393 examples: default: &656 value: @@ -97357,8 +97419,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *439 - *440 + - *441 - &657 name: milestone_number description: The number that identifies the milestone. @@ -97371,7 +97433,7 @@ paths: description: Response content: application/json: - schema: *392 + schema: *393 examples: default: *656 '404': *6 @@ -97390,8 +97452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *439 - *440 + - *441 - *657 requestBody: required: false @@ -97430,7 +97492,7 @@ paths: description: Response content: application/json: - schema: *392 + schema: *393 examples: default: *656 x-github: @@ -97448,8 +97510,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *439 - *440 + - *441 - *657 responses: '204': @@ -97471,8 +97533,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *439 - *440 + - *441 - *657 - *17 - *19 @@ -97504,8 +97566,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *439 - *440 + - *441 - *658 - *659 - *219 @@ -97545,8 +97607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -97604,8 +97666,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -97796,8 +97858,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -97877,8 +97939,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -97986,8 +98048,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -98013,8 +98075,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -98116,8 +98178,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *439 - *440 + - *441 responses: '201': description: Response @@ -98164,8 +98226,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -98221,8 +98283,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *439 - *440 + - *441 - name: build_id in: path required: true @@ -98255,8 +98317,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -98364,8 +98426,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *439 - *440 + - *441 - &666 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit @@ -98424,8 +98486,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *439 - *440 + - *441 - *666 responses: '204': *149 @@ -98453,8 +98515,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -98749,8 +98811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Private vulnerability reporting status @@ -98787,8 +98849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': *149 '422': *14 @@ -98809,8 +98871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': *149 '422': *14 @@ -98832,8 +98894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -98865,8 +98927,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -98920,8 +98982,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *439 - *440 + - *441 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -98981,7 +99043,7 @@ paths: application/json: schema: type: array - items: *557 + items: *558 examples: default: *669 headers: @@ -99015,8 +99077,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -99212,7 +99274,7 @@ paths: milestone: anyOf: - type: 'null' - - *392 + - *393 active_lock_reason: type: - string @@ -99267,7 +99329,7 @@ paths: type: - array - 'null' - items: *371 + items: *372 head: type: object properties: @@ -99305,14 +99367,14 @@ paths: _links: type: object properties: - comments: *393 - commits: *393 - statuses: *393 - html: *393 - issue: *393 - review_comments: *393 - review_comment: *393 - self: *393 + comments: *394 + commits: *394 + statuses: *394 + html: *394 + issue: *394 + review_comments: *394 + review_comment: *394 + self: *394 required: - comments - commits @@ -99952,8 +100014,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *439 - *440 + - *441 - name: sort in: query required: false @@ -100061,8 +100123,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *439 - *440 + - *441 - *228 responses: '200': @@ -100146,8 +100208,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -100188,8 +100250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *439 - *440 + - *441 - *228 responses: '204': @@ -100211,8 +100273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *439 - *440 + - *441 - *228 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -100239,7 +100301,7 @@ paths: application/json: schema: type: array - items: *551 + items: *552 examples: default: *630 headers: @@ -100262,8 +100324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -100296,16 +100358,16 @@ paths: description: Reaction exists content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '201': description: Reaction created content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '422': *15 x-github: githubCloudOnly: false @@ -100327,8 +100389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *439 - *440 + - *441 - *228 - *631 responses: @@ -100373,8 +100435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *439 - *440 + - *441 - &675 name: pull_number description: The number that identifies the pull request. @@ -100425,8 +100487,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: false @@ -100493,8 +100555,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: true @@ -100556,17 +100618,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '401': *23 '403': *27 '404': *6 @@ -100596,8 +100658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *236 - name: direction @@ -100654,8 +100716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: true @@ -100850,8 +100912,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *439 - *440 + - *441 - *675 - *228 requestBody: @@ -100961,8 +101023,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *17 - *19 @@ -100973,7 +101035,7 @@ paths: application/json: schema: type: array - items: *553 + items: *554 examples: default: *677 headers: @@ -101005,8 +101067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *439 - *440 + - *441 - *675 - *17 - *19 @@ -101017,7 +101079,7 @@ paths: application/json: schema: type: array - items: *564 + items: *565 examples: default: value: @@ -101055,8 +101117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *439 - *440 + - *441 - *675 responses: '204': @@ -101080,8 +101142,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: false @@ -101194,8 +101256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 responses: '200': @@ -101271,8 +101333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: false @@ -101310,7 +101372,7 @@ paths: description: Response content: application/json: - schema: *557 + schema: *558 examples: default: value: @@ -101846,8 +101908,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: true @@ -101882,7 +101944,7 @@ paths: description: Response content: application/json: - schema: *557 + schema: *558 examples: default: value: @@ -102387,8 +102449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *17 - *19 @@ -102555,8 +102617,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: false @@ -102712,8 +102774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - &679 name: review_id @@ -102788,8 +102850,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *679 requestBody: @@ -102876,8 +102938,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *679 responses: @@ -102914,8 +102976,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *439 - *440 + - *441 - *675 - *679 - *17 @@ -103015,9 +103077,9 @@ paths: _links: type: object properties: - self: *393 - html: *393 - pull_request: *393 + self: *394 + html: *394 + pull_request: *394 required: - self - html @@ -103175,8 +103237,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *679 requestBody: @@ -103270,8 +103332,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *679 requestBody: @@ -103332,8 +103394,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *439 - *440 + - *441 - *675 requestBody: required: false @@ -103398,8 +103460,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *439 - *440 + - *441 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -103456,8 +103518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *439 - *440 + - *441 - name: dir description: The alternate path to look for a README file in: path @@ -103501,8 +103563,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -103606,8 +103668,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -103790,8 +103852,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *439 - *440 + - *441 - &686 name: asset_id description: The unique identifier of the asset. @@ -103841,7 +103903,7 @@ paths: type: User site_admin: false '404': *6 - '302': *566 + '302': *567 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103857,8 +103919,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *439 - *440 + - *441 - *686 requestBody: required: false @@ -103906,8 +103968,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *439 - *440 + - *441 - *686 responses: '204': @@ -103932,8 +103994,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -104019,8 +104081,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -104045,8 +104107,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *439 - *440 + - *441 - name: tag description: tag parameter in: path @@ -104083,8 +104145,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *439 - *440 + - *441 - &689 name: release_id description: The unique identifier of the release. @@ -104119,8 +104181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *439 - *440 + - *441 - *689 requestBody: required: false @@ -104208,8 +104270,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *439 - *440 + - *441 - *689 responses: '204': @@ -104230,8 +104292,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *439 - *440 + - *441 - *689 - *17 - *19 @@ -104324,8 +104386,8 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *439 - *440 + - *441 - *689 - name: name in: query @@ -104407,8 +104469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *439 - *440 + - *441 - *689 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -104433,7 +104495,7 @@ paths: application/json: schema: type: array - items: *551 + items: *552 examples: default: *630 headers: @@ -104456,8 +104518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *439 - *440 + - *441 - *689 requestBody: required: true @@ -104488,16 +104550,16 @@ paths: description: Reaction exists content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '201': description: Reaction created content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '422': *15 x-github: githubCloudOnly: false @@ -104519,8 +104581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *439 - *440 + - *441 - *689 - *631 responses: @@ -104546,9 +104608,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *439 - *440 - - *492 + - *441 + - *493 - *17 - *19 responses: @@ -104685,8 +104747,8 @@ paths: category: repos subcategory: rules parameters: - - *439 - *440 + - *441 - *17 - *19 - name: includes_parents @@ -104752,8 +104814,8 @@ paths: category: repos subcategory: rules parameters: - - *439 - *440 + - *441 requestBody: description: Request body required: true @@ -104862,8 +104924,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *439 - *440 + - *441 - *694 - *103 - *695 @@ -104898,8 +104960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *439 - *440 + - *441 - *699 responses: '200': @@ -104936,8 +104998,8 @@ paths: category: repos subcategory: rules parameters: - - *439 - *440 + - *441 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104977,8 +105039,8 @@ paths: category: repos subcategory: rules parameters: - - *439 - *440 + - *441 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105060,8 +105122,8 @@ paths: category: repos subcategory: rules parameters: - - *439 - *440 + - *441 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105084,8 +105146,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *439 - *440 + - *441 - *17 - *19 - name: ruleset_id @@ -105103,7 +105165,7 @@ paths: type: array items: *189 examples: - default: *409 + default: *410 '404': *6 '500': *38 x-github: @@ -105122,8 +105184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *439 - *440 + - *441 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105141,15 +105203,15 @@ paths: description: Response content: application/json: - schema: *410 + schema: *411 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 @@ -105196,22 +105258,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *439 - *440 - - *411 + - *441 - *412 - *413 - *414 - *415 + - *416 - *108 - *19 - *17 - *703 - *704 - - *416 - *417 - *418 - *419 + - *420 responses: '200': description: Response @@ -105475,10 +105537,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *439 - *440 - - *519 - - *419 + - *441 + - *520 + - *420 responses: '200': description: Response @@ -105538,9 +105600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 requestBody: required: true content: @@ -105680,9 +105742,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 - *19 - *17 responses: @@ -105818,8 +105880,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -105898,8 +105960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *439 - *440 + - *441 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -106020,8 +106082,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *439 - *440 + - *441 - *108 - name: sort description: The property to sort the results by. @@ -106090,8 +106152,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -106171,7 +106233,7 @@ paths: login: type: string description: The username of the user credited. - type: *424 + type: *425 required: - login - type @@ -106496,8 +106558,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -106757,8 +106819,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *439 - *440 + - *441 - *727 responses: '200': @@ -106791,8 +106853,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *439 - *440 + - *441 - *727 requestBody: required: true @@ -106873,7 +106935,7 @@ paths: login: type: string description: The username of the user credited. - type: *424 + type: *425 required: - login - type @@ -107005,8 +107067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *439 - *440 + - *441 - *727 responses: '202': *37 @@ -107034,17 +107096,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *439 - *440 + - *441 - *727 responses: '202': description: Response content: application/json: - schema: *444 + schema: *445 examples: - default: *446 + default: *447 '400': *14 '422': *15 '403': *27 @@ -107070,8 +107132,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -107167,8 +107229,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *439 - *440 + - *441 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -107210,8 +107272,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -107289,8 +107351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -107384,8 +107446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *439 - *440 + - *441 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -107539,8 +107601,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *439 - *440 + - *441 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -107583,8 +107645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *439 - *440 + - *441 - name: sha in: path required: true @@ -107694,8 +107756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -107727,8 +107789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *439 - *440 + - *441 responses: '200': description: if you subscribe to the repository @@ -107807,8 +107869,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -107861,8 +107923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -107882,8 +107944,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -107965,8 +108027,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -108031,8 +108093,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -108086,8 +108148,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *439 - *440 + - *441 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -108124,8 +108186,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *439 - *440 + - *441 - name: ref in: path required: true @@ -108161,8 +108223,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -108174,7 +108236,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 headers: Link: *45 '404': *6 @@ -108194,8 +108256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *439 - *440 + - *441 - *19 - *17 responses: @@ -108238,8 +108300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -108293,8 +108355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *439 - *440 + - *441 - &735 name: per description: The time frame to display results for. @@ -108413,8 +108475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -108508,8 +108570,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -108572,8 +108634,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *439 - *440 + - *441 - *735 responses: '200': @@ -108672,8 +108734,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -108947,8 +109009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -108971,8 +109033,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -108994,8 +109056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -109021,8 +109083,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *439 - *440 + - *441 - name: ref in: path required: true @@ -109114,9 +109176,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *445 examples: - default: *446 + default: *447 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -111668,7 +111730,7 @@ paths: committer: anyOf: - type: 'null' - - *490 + - *491 comment_count: type: integer message: @@ -111687,7 +111749,7 @@ paths: url: type: string format: uri - verification: *613 + verification: *614 required: - author - committer @@ -111702,7 +111764,7 @@ paths: committer: anyOf: - type: 'null' - - *490 + - *491 parents: type: array items: @@ -112027,7 +112089,7 @@ paths: milestone: anyOf: - type: 'null' - - *392 + - *393 comments: type: integer created_at: @@ -112090,7 +112152,7 @@ paths: timeline_url: type: string format: uri - type: *358 + type: *359 performed_via_github_app: anyOf: - type: 'null' @@ -113340,9 +113402,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '404': *6 x-github: githubCloudOnly: false @@ -113433,16 +113495,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '201': description: Response content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '404': *6 '422': *15 '403': *27 @@ -113509,9 +113571,9 @@ paths: application/json: schema: type: array - items: *355 + items: *356 examples: - default: *356 + default: *357 headers: Link: *45 x-github: @@ -113709,7 +113771,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *439 examples: response-if-user-is-a-team-maintainer: *769 '404': *6 @@ -113770,7 +113832,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *439 examples: response-if-users-membership-with-team-is-now-pending: *770 '403': @@ -113846,7 +113908,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 '404': *6 @@ -113877,8 +113939,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - *768 - - *439 - *440 + - *441 responses: '200': description: Alternative response with extra repository information @@ -114036,8 +114098,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - *768 - - *439 - *440 + - *441 requestBody: required: false content: @@ -114088,8 +114150,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - *768 - - *439 - *440 + - *441 responses: '204': description: Response @@ -114124,9 +114186,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *442 examples: - default: *442 + default: *443 '403': *27 '404': *6 x-github: @@ -114214,7 +114276,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *442 examples: default: value: @@ -114903,9 +114965,9 @@ paths: type: integer codespaces: type: array - items: *363 + items: *364 examples: - default: *364 + default: *365 '304': *35 '500': *38 '401': *23 @@ -115044,17 +115106,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '401': *23 '403': *27 '404': *6 @@ -115140,7 +115202,7 @@ paths: - visibility - selected_repositories_url examples: - default: *544 + default: *545 headers: Link: *45 x-github: @@ -115508,15 +115570,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 responses: '200': description: Response content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '304': *35 '500': *38 '401': *23 @@ -115542,7 +115604,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 requestBody: required: false content: @@ -115572,9 +115634,9 @@ paths: description: Response content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '401': *23 '403': *27 '404': *6 @@ -115596,7 +115658,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 responses: '202': *37 '304': *35 @@ -115625,7 +115687,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 responses: '202': description: Response @@ -115716,7 +115778,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *365 + - *366 - name: export_id in: path required: true @@ -115752,7 +115814,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *365 + - *366 responses: '200': description: Response @@ -115768,7 +115830,7 @@ paths: type: integer machines: type: array - items: *543 + items: *544 examples: default: *779 '304': *35 @@ -115799,7 +115861,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *365 + - *366 requestBody: required: true content: @@ -115855,11 +115917,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *444 + repository: *445 machine: anyOf: - type: 'null' - - *543 + - *544 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -116656,15 +116718,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 responses: '200': description: Response content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '304': *35 '500': *38 '400': *14 @@ -116696,15 +116758,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 responses: '200': description: Response content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '500': *38 '401': *23 '403': *27 @@ -116734,7 +116796,7 @@ paths: application/json: schema: type: array - items: *373 + items: *374 examples: default: &790 value: @@ -117848,12 +117910,12 @@ paths: application/json: schema: anyOf: - - *353 + - *354 - type: object properties: {} additionalProperties: false examples: - default: *354 + default: *355 '204': description: Response when there are no restrictions x-github: @@ -117888,7 +117950,7 @@ paths: description: Response content: application/json: - schema: *353 + schema: *354 examples: default: value: @@ -117969,7 +118031,7 @@ paths: - closed - all default: open - - *361 + - *362 - name: sort description: What to sort results by. in: query @@ -117994,7 +118056,7 @@ paths: type: array items: *213 examples: - default: *362 + default: *363 headers: Link: *45 '404': *6 @@ -118412,7 +118474,7 @@ paths: application/json: schema: type: array - items: *366 + items: *367 examples: default: value: @@ -118526,7 +118588,7 @@ paths: description: Response content: application/json: - schema: *366 + schema: *367 examples: default: value: @@ -118613,7 +118675,7 @@ paths: description: Response content: application/json: - schema: *366 + schema: *367 examples: default: value: @@ -118685,7 +118747,7 @@ paths: application/json: schema: type: array - items: *368 + items: *369 examples: default: value: @@ -118947,7 +119009,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *369 examples: default: value: @@ -119127,7 +119189,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *369 + - *370 - name: exclude in: query required: false @@ -119140,7 +119202,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *369 examples: default: value: @@ -119334,7 +119396,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *369 + - *370 responses: '302': description: Response @@ -119360,7 +119422,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *369 + - *370 responses: '204': description: Response @@ -119389,7 +119451,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *369 + - *370 - *788 responses: '204': @@ -119414,7 +119476,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *369 + - *370 - *17 - *19 responses: @@ -119426,7 +119488,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 '404': *6 @@ -119515,7 +119577,7 @@ paths: application/json: schema: type: array - items: *373 + items: *374 examples: default: *790 '400': *791 @@ -119538,14 +119600,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *375 - *376 + - *377 responses: '200': description: Response content: application/json: - schema: *373 + schema: *374 examples: default: &809 value: @@ -119660,8 +119722,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *375 - *376 + - *377 responses: '204': description: Response @@ -119691,8 +119753,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *375 - *376 + - *377 - name: token description: package token schema: @@ -119724,8 +119786,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *375 - *376 + - *377 - *19 - *17 - name: state @@ -119745,7 +119807,7 @@ paths: application/json: schema: type: array - items: *377 + items: *378 examples: default: value: @@ -119794,15 +119856,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *375 - *376 - - *378 + - *377 + - *379 responses: '200': description: Response content: application/json: - schema: *377 + schema: *378 examples: default: value: @@ -119838,9 +119900,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *375 - *376 - - *378 + - *377 + - *379 responses: '204': description: Response @@ -119870,9 +119932,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *375 - *376 - - *378 + - *377 + - *379 responses: '204': description: Response @@ -120342,9 +120404,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *445 examples: - default: *446 + default: *447 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -120407,7 +120469,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *357 + - *358 responses: '204': description: Response @@ -120430,7 +120492,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *357 + - *358 responses: '204': description: Response @@ -121001,8 +121063,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *439 - *440 + - *441 responses: '204': description: Response if this repository is starred by you @@ -121030,8 +121092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -121055,8 +121117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -121091,7 +121153,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 '304': *35 @@ -121128,7 +121190,7 @@ paths: application/json: schema: type: array - items: *432 + items: *433 examples: default: value: @@ -121316,7 +121378,7 @@ paths: required: true schema: type: string - - *391 + - *392 requestBody: required: true description: Details of the draft item to create in the project. @@ -121350,9 +121412,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *397 examples: - draft_issue: *397 + draft_issue: *398 '304': *35 '403': *27 '401': *23 @@ -121411,7 +121473,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-a-user-owned-project parameters: - *801 - - *391 + - *392 requestBody: required: true content: @@ -121489,13 +121551,13 @@ paths: examples: table_view: summary: Response for creating a table view - value: *401 + value: *402 board_view: summary: Response for creating a board view with filter - value: *401 + value: *402 roadmap_view: summary: Response for creating a roadmap view - value: *401 + value: *402 '304': *35 '403': *27 '401': *23 @@ -121851,7 +121913,7 @@ paths: initiator: type: string examples: - default: *486 + default: *487 '201': description: Response content: @@ -121890,7 +121952,7 @@ paths: application/json: schema: type: array - items: *373 + items: *374 examples: default: *790 '403': *27 @@ -122382,7 +122444,7 @@ paths: application/json: schema: *20 examples: - default: *623 + default: *352 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122518,7 +122580,7 @@ paths: application/json: schema: type: array - items: *373 + items: *374 examples: default: *790 '403': *27 @@ -122543,15 +122605,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *375 - *376 + - *377 - *137 responses: '200': description: Response content: application/json: - schema: *373 + schema: *374 examples: default: *809 x-github: @@ -122574,8 +122636,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *375 - *376 + - *377 - *137 responses: '204': @@ -122608,8 +122670,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *375 - *376 + - *377 - *137 - name: token description: package token @@ -122642,8 +122704,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *375 - *376 + - *377 - *137 responses: '200': @@ -122652,7 +122714,7 @@ paths: application/json: schema: type: array - items: *377 + items: *378 examples: default: value: @@ -122710,16 +122772,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user parameters: - - *375 - *376 - - *378 + - *377 + - *379 - *137 responses: '200': description: Response content: application/json: - schema: *377 + schema: *378 examples: default: value: @@ -122754,10 +122816,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *375 - *376 + - *377 - *137 - - *378 + - *379 responses: '204': description: Response @@ -122789,10 +122851,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *375 - *376 + - *377 - *137 - - *378 + - *379 responses: '204': description: Response @@ -122833,9 +122895,9 @@ paths: application/json: schema: type: array - items: *389 + items: *390 examples: - default: *390 + default: *391 headers: Link: *45 '304': *35 @@ -122857,16 +122919,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *391 + - *392 - *137 responses: '200': description: Response content: application/json: - schema: *389 + schema: *390 examples: - default: *390 + default: *391 headers: Link: *45 '304': *35 @@ -122888,7 +122950,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *391 + - *392 - *137 - *17 - *106 @@ -122900,7 +122962,7 @@ paths: application/json: schema: type: array - items: *394 + items: *395 examples: default: *810 headers: @@ -122924,7 +122986,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project parameters: - *137 - - *391 + - *392 requestBody: required: true content: @@ -123007,7 +123069,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *395 examples: text_field: *815 number_field: *816 @@ -123034,7 +123096,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *391 + - *392 - *820 - *137 responses: @@ -123042,7 +123104,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *395 examples: default: *821 headers: @@ -123067,7 +123129,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project parameters: - - *391 + - *392 - *137 - *106 - *107 @@ -123100,9 +123162,9 @@ paths: application/json: schema: type: array - items: *398 + items: *399 examples: - default: *399 + default: *400 headers: Link: *45 '304': *35 @@ -123124,7 +123186,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - *137 - - *391 + - *392 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -123194,22 +123256,22 @@ paths: description: Response content: application/json: - schema: *396 + schema: *397 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *397 + value: *398 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *397 + value: *398 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *397 + value: *398 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *397 + value: *398 '304': *35 '403': *27 '401': *23 @@ -123229,9 +123291,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *391 + - *392 - *137 - - *400 + - *401 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -123251,9 +123313,9 @@ paths: description: Response content: application/json: - schema: *398 + schema: *399 examples: - default: *399 + default: *400 headers: Link: *45 '304': *35 @@ -123274,9 +123336,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *391 + - *392 - *137 - - *400 + - *401 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -123349,13 +123411,13 @@ paths: description: Response content: application/json: - schema: *398 + schema: *399 examples: - text_field: *399 - number_field: *399 - date_field: *399 - single_select_field: *399 - iteration_field: *399 + text_field: *400 + number_field: *400 + date_field: *400 + single_select_field: *400 + iteration_field: *400 '401': *23 '403': *27 '404': *6 @@ -123375,9 +123437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *391 + - *392 - *137 - - *400 + - *401 responses: '204': description: Response @@ -123399,7 +123461,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-project-view parameters: - - *391 + - *392 - *137 - *822 - name: fields @@ -123427,9 +123489,9 @@ paths: application/json: schema: type: array - items: *398 + items: *399 examples: - default: *399 + default: *400 headers: Link: *45 '304': *35 @@ -123650,7 +123712,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -123786,7 +123848,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -126642,7 +126704,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -126693,7 +126754,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -127039,7 +127099,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -127090,7 +127149,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -127436,7 +127494,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -127487,7 +127544,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -127848,7 +127904,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -127899,7 +127954,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -128471,11 +128525,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129185,11 +129234,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129892,11 +129936,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130315,7 +130354,7 @@ webhooks: required: - login - id - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -130647,7 +130686,7 @@ webhooks: required: - login - id - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -130991,7 +131030,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131350,7 +131389,7 @@ webhooks: required: - login - id - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -131633,7 +131672,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131931,7 +131970,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -132252,7 +132291,7 @@ webhooks: required: - login - id - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -133364,7 +133403,7 @@ webhooks: type: string enum: - auto_dismissed - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133452,7 +133491,7 @@ webhooks: type: string enum: - auto_reopened - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133540,7 +133579,7 @@ webhooks: type: string enum: - created - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133626,7 +133665,7 @@ webhooks: type: string enum: - dismissed - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133712,7 +133751,7 @@ webhooks: type: string enum: - fixed - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133799,7 +133838,7 @@ webhooks: type: string enum: - reintroduced - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133885,7 +133924,7 @@ webhooks: type: string enum: - reopened - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -134590,11 +134629,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135403,7 +135437,7 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *578 + deployment: *579 pull_requests: type: array items: *673 @@ -138475,502 +138509,492 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - deployment_status: - description: The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses). - type: object - properties: - created_at: - type: string - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - deployment_url: - type: string - format: uri - description: - description: The optional human-readable description added to - the status. - type: string - environment: - type: string - environment_url: - type: string - format: uri - id: - type: integer - log_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - merge_queue_entry - - workflow_job - - merge_group - - secret_scanning_alert_location - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + production_environment: + type: boolean + ref: + type: string + repository_url: + type: string + format: uri + sha: + type: string + statuses_url: + type: string + format: uri + task: + type: string + transient_environment: + type: boolean + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - id + - node_id + - sha + - ref + - task + - payload + - original_environment + - environment + - description + - creator + - created_at + - updated_at + - statuses_url + - repository_url + deployment_status: + description: The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + deployment_url: + type: string + format: uri + description: + description: The optional human-readable description added to + the status. + type: string + environment: + type: string + environment_url: + type: string + format: uri + id: + type: integer + log_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps are + first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - pull_request_review_thread + - merge_queue_entry + - workflow_job + - merge_group + - secret_scanning_alert_location + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -144575,6 +144599,9 @@ webhooks: description: URL for the issue comment type: string format: uri + pin: + anyOf: + - type: 'null' user: title: User type: @@ -145386,7 +145413,2694 @@ webhooks: enum: - read - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: *765 + issue_dependencies_summary: *766 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *359 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - labels + - state + - locked + - assignee + organization: *828 + repository: *829 + 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-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: &857 + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + pin: + anyOf: + - type: 'null' + required: + - url + - html_url + - issue_url + - id + - node_id + - user + - created_at + - updated_at + - author_association + - performed_via_github_app + - body + - reactions + enterprise: *826 + installation: *827 + issue: + description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: *765 + issue_dependencies_summary: *766 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *359 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: *828 + repository: *829 + 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: &881 + 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: *857 + enterprise: *826 + installation: *827 + issue: + description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -145496,7 +148210,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -145845,6 +148559,7 @@ webhooks: sender: *4 required: - action + - changes - issue - comment - repository @@ -145861,7 +148576,7 @@ webhooks: - repository - organization - app - issue-comment-deleted: + issue-comment-pinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. @@ -145869,8 +148584,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/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: @@ -145914,180 +148629,14 @@ webhooks: content: application/json: schema: - title: issue_comment deleted event + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted - comment: &857 - 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 - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: *857 enterprise: *826 installation: *827 issue: @@ -146920,7 +149469,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -147287,7 +149836,7 @@ webhooks: - repository - organization - app - issue-comment-edited: + issue-comment-unpinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/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. @@ -147295,8 +149844,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/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: @@ -147340,25 +149889,13 @@ webhooks: content: application/json: schema: - title: issue_comment edited event + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: &881 - 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: *857 enterprise: *826 installation: *827 @@ -147829,8 +150366,6 @@ webhooks: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: - string @@ -148014,7 +150549,6 @@ webhooks: enum: - read - write - - admin organization_secrets: type: string enum: @@ -148195,7 +150729,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -148534,6 +151068,8 @@ webhooks: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -148544,7 +151080,6 @@ webhooks: sender: *4 required: - action - - changes - issue - comment - repository @@ -149707,11 +152242,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -149820,7 +152350,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -150730,11 +153260,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -150843,7 +153368,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -151886,11 +154411,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -151999,7 +154519,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -152931,11 +155451,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -153034,7 +155549,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -154079,11 +156594,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -154189,7 +156699,7 @@ webhooks: timeline_url: type: string format: uri - type: *358 + type: *359 title: description: Title of the issue type: string @@ -155097,11 +157607,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -155207,7 +157712,7 @@ webhooks: timeline_url: type: string format: uri - type: *358 + type: *359 title: description: Title of the issue type: string @@ -156150,11 +158655,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -156250,7 +158750,7 @@ webhooks: timeline_url: type: string format: uri - type: *358 + type: *359 title: description: Title of the issue type: string @@ -157162,11 +159662,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -157265,7 +159760,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -158147,11 +160642,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -158339,7 +160829,7 @@ webhooks: required: - login - id - type: *358 + type: *359 required: - id - number @@ -159541,11 +162031,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -159654,7 +162139,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -160553,11 +163038,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -160666,7 +163146,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -161601,11 +164081,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -161784,7 +164259,7 @@ webhooks: format: uri user_view_type: type: string - type: *358 + type: *359 organization: *828 repository: *829 sender: *4 @@ -162583,11 +165058,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -162696,7 +165166,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -163365,7 +165835,7 @@ webhooks: enterprise: *826 installation: *827 issue: *860 - type: *358 + type: *359 organization: *828 repository: *829 sender: *4 @@ -164441,11 +166911,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -164544,7 +167009,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -164791,7 +167256,7 @@ webhooks: enterprise: *826 installation: *827 issue: *860 - type: *358 + type: *359 organization: *828 repository: *829 sender: *4 @@ -166797,7 +169262,7 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *506 + head_commit: *507 required: - head_sha - head_ref @@ -172904,7 +175369,7 @@ webhooks: - closed installation: *827 organization: *828 - projects_v2: *389 + projects_v2: *390 sender: *4 required: - action @@ -172987,7 +175452,7 @@ webhooks: - created installation: *827 organization: *828 - projects_v2: *389 + projects_v2: *390 sender: *4 required: - action @@ -173070,7 +175535,7 @@ webhooks: - deleted installation: *827 organization: *828 - projects_v2: *389 + projects_v2: *390 sender: *4 required: - action @@ -173193,7 +175658,7 @@ webhooks: type: string installation: *827 organization: *828 - projects_v2: *389 + projects_v2: *390 sender: *4 required: - action @@ -173312,7 +175777,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *395 + content_type: *396 creator: *4 created_at: type: string @@ -174067,7 +176532,7 @@ webhooks: - reopened installation: *827 organization: *828 - projects_v2: *389 + projects_v2: *390 sender: *4 required: - action @@ -182060,7 +184525,7 @@ webhooks: enum: - demilestoned enterprise: *826 - milestone: *392 + milestone: *393 number: *878 organization: *828 pull_request: &880 @@ -194306,7 +196771,7 @@ webhooks: enum: - milestoned enterprise: *826 - milestone: *392 + milestone: *393 number: *878 organization: *828 pull_request: *880 @@ -239174,6 +241639,7 @@ webhooks: state: type: string enum: + - auto_dismissed - open enterprise: *826 installation: *827 @@ -241279,11 +243745,11 @@ webhooks: from: type: object properties: - security_and_analysis: *403 + security_and_analysis: *404 enterprise: *826 installation: *827 organization: *828 - repository: *444 + repository: *445 sender: *4 required: - changes @@ -246613,7 +249079,7 @@ webhooks: type: string required: - conclusion - deployment: *578 + deployment: *579 required: - action - repository @@ -246977,7 +249443,7 @@ webhooks: required: - status - steps - deployment: *578 + deployment: *579 required: - action - repository @@ -247205,7 +249671,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *578 + deployment: *579 required: - action - repository @@ -247434,7 +249900,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *578 + deployment: *579 required: - action - repository diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 93e1fdf2a..69cf37ef4 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -5798,14 +5798,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -6954,14 +6946,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -7883,14 +7867,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -8377,14 +8353,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -10729,14 +10697,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -11917,14 +11877,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -12969,14 +12921,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -13724,14 +13668,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -31288,14 +31224,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -32175,9 +32103,1100 @@ "write" ] }, - "team_discussions": { + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "enterprise_organization_installations": { + "type": "string", + "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_organization_installation_repositories": { "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "description": "The level of permission to grant the access token to manage repository access of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "repository_selection": "selected", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + } + } + } + } + }, + "201": { + "description": "A GitHub App installation.", + "content": { + "application/json": { + "schema": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" @@ -32584,9 +33603,406 @@ } } } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "client_id": { + "type": "string", + "description": "The Client ID of the GitHub App to install." + }, + "repository_selection": { + "type": "string", + "description": "The repository selection for the GitHub App. Must be one of:\n* `all` - the installation can access all repositories in the organization.\n* `selected` - the installation can access only the listed repositories.\n* `none` - no repository permissions are requested. Only use when the app does not request repository permissions.", + "enum": [ + "all", + "selected", + "none" + ] + }, + "repositories": { + "type": "array", + "description": "The names of the repositories to which the installation will be granted access. This is the simple name of the repository, not the full name (e.g., `hello-world` not `octocat/hello-world`). This is only required when `repository_selection` is `selected`.", + "items": { + "type": "string" + }, + "maxItems": 50 + } + }, + "required": [ + "client_id", + "repository_selection" + ] + }, + "examples": { + "default": { + "summary": "Example of installing a GitHub App on an organization and granting access to all of its repositories.", + "value": { + "client_id": "Iv2abc123aabbcc", + "repository_selection": "all" + } + }, + "repository_selection_selected": { + "value": { + "client_id": "Iv2abc123aabbcc", + "repository_selection": "selected", + "repositories": [ + "hello-world", + "hello-world-2" + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "organization-installations" + } + } + }, + "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}": { + "delete": { + "summary": "Uninstall a GitHub App from an enterprise-owned organization", + "description": "Uninstall a GitHub App from an organization. Any app installed on the organization can be removed.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", + "tags": [ + "apps" + ], + "operationId": "enterprise-apps/delete-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "201": { - "description": "A GitHub App installation.", + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + } + ], + "responses": { + "204": { + "description": "An empty response indicates that the installation was successfully removed." + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "organization-installations" + } + } + }, + "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories": { + "get": { + "summary": "Get the repositories accessible to a given GitHub App installation", + "description": "Lists the repositories accessible to a given GitHub App installation on an enterprise-owned organization.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", + "tags": [ + "apps" + ], + "operationId": "enterprise-apps/organization-installation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "A list of repositories owned by the enterprise organization to which the installation has access.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Accessible Repository", + "description": "A repository that may be made accessible to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + } + }, + "required": [ + "full_name", + "id", + "name" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "name": "Hello World", + "full_name": "octocat/Hello-World" + }, + { + "id": 2, + "login": "Goodbye World", + "full_name": "octocat/Goodbye-World" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "organization-installations" + } + }, + "patch": { + "summary": "Toggle installation repository access between selected and all repositories", + "description": "Toggle repository access for a GitHub App installation between all repositories and selected repositories. You must provide at least one repository when changing the access to 'selected'. If you change the access to 'all', the repositories list must not be provided.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", + "tags": [ + "apps" + ], + "operationId": "enterprise-apps/change-installation-repository-access-selection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_selection": { + "type": "string", + "description": "One of either 'all' or 'selected'", + "enum": [ + "all", + "selected" + ] + }, + "repositories": { + "type": "array", + "description": "The repository names to add to the installation. Only required when repository_selection is 'selected'", + "items": { + "type": "string" + }, + "maxItems": 50 + } + }, + "required": [ + "repository_selection" + ] + }, + "examples": { + "default": { + "summary": "Change the repositories accessible to a GitHub App from 'all repositories' to a specified subset.", + "value": { + "repository_selection": "selected", + "repositories": [ + "hello-world", + "hello-world-2" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "The GitHub App installation that was updated.", "content": { "application/json": { "schema": { @@ -33282,1518 +34698,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - }, - "enterprise_custom_properties_for_organizations": { - "type": "string", - "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "enterprise_organization_installations": { - "type": "string", - "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", - "enum": [ - "read", - "write" - ] - }, - "enterprise_organization_installation_repositories": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository access of GitHub Apps on Enterprise-owned organizations.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" - ] - } - }, - "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "account": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/organizations/github/settings/installations/1", - "app_id": 1, - "target_id": 1, - "target_type": "Organization", - "permissions": { - "checks": "write", - "metadata": "read", - "contents": "read" - }, - "events": [ - "push", - "pull_request" - ], - "single_file_name": "config.yaml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "repository_selection": "selected", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - } - } - } - } - } - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_id": { - "type": "string", - "description": "The Client ID of the GitHub App to install." - }, - "repository_selection": { - "type": "string", - "description": "The repository selection for the GitHub App. Must be one of:\n* `all` - the installation can access all repositories in the organization.\n* `selected` - the installation can access only the listed repositories.\n* `none` - no repository permissions are requested. Only use when the app does not request repository permissions.", - "enum": [ - "all", - "selected", - "none" - ] - }, - "repositories": { - "type": "array", - "description": "The names of the repositories to which the installation will be granted access. This is the simple name of the repository, not the full name (e.g., `hello-world` not `octocat/hello-world`). This is only required when `repository_selection` is `selected`.", - "items": { - "type": "string" - }, - "maxItems": 50 - } - }, - "required": [ - "client_id", - "repository_selection" - ] - }, - "examples": { - "default": { - "summary": "Example of installing a GitHub App on an organization and granting access to all of its repositories.", - "value": { - "client_id": "Iv2abc123aabbcc", - "repository_selection": "all" - } - }, - "repository_selection_selected": { - "value": { - "client_id": "Iv2abc123aabbcc", - "repository_selection": "selected", - "repositories": [ - "hello-world", - "hello-world-2" - ] - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "organization-installations" - } - } - }, - "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}": { - "delete": { - "summary": "Uninstall a GitHub App from an enterprise-owned organization", - "description": "Uninstall a GitHub App from an organization. Any app installed on the organization can be removed.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", - "tags": [ - "apps" - ], - "operationId": "enterprise-apps/delete-installation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "examples": { - "default": { - "value": 1 - } - } - } - ], - "responses": { - "204": { - "description": "An empty response indicates that the installation was successfully removed." - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "organization-installations" - } - } - }, - "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories": { - "get": { - "summary": "Get the repositories accessible to a given GitHub App installation", - "description": "Lists the repositories accessible to a given GitHub App installation on an enterprise-owned organization.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", - "tags": [ - "apps" - ], - "operationId": "enterprise-apps/organization-installation-repositories", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "examples": { - "default": { - "value": 1 - } - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "A list of repositories owned by the enterprise organization to which the installation has access.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Accessible Repository", - "description": "A repository that may be made accessible to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - } - }, - "required": [ - "full_name", - "id", - "name" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "name": "Hello World", - "full_name": "octocat/Hello-World" - }, - { - "id": 2, - "login": "Goodbye World", - "full_name": "octocat/Goodbye-World" - } - ] - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "organization-installations" - } - }, - "patch": { - "summary": "Toggle installation repository access between selected and all repositories", - "description": "Toggle repository access for a GitHub App installation between all repositories and selected repositories. You must provide at least one repository when changing the access to 'selected'. If you change the access to 'all', the repositories list must not be provided.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", - "tags": [ - "apps" - ], - "operationId": "enterprise-apps/change-installation-repository-access-selection", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "examples": { - "default": { - "value": 1 - } - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repository_selection": { - "type": "string", - "description": "One of either 'all' or 'selected'", - "enum": [ - "all", - "selected" - ] - }, - "repositories": { - "type": "array", - "description": "The repository names to add to the installation. Only required when repository_selection is 'selected'", - "items": { - "type": "string" - }, - "maxItems": 50 - } - }, - "required": [ - "repository_selection" - ] - }, - "examples": { - "default": { - "summary": "Change the repositories accessible to a GitHub App from 'all repositories' to a specified subset.", - "value": { - "repository_selection": "selected", - "repositories": [ - "hello-world", - "hello-world-2" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "The GitHub App installation that was updated.", - "content": { - "application/json": { - "schema": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/app/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "Iv1.ab1112223334445c" - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "custom_properties_for_organizations": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -51724,6 +51628,1139 @@ } } }, + "/enterprises/{enterprise}/installation": { + "get": { + "summary": "Get an enterprise installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find its installation on a particular enterprise.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-enterprise-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "enterprise_organization_installations": { + "type": "string", + "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_organization_installation_repositories": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository access of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "account": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/orgs/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "all", + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "client_id": "Iv1.ab1112223334445c", + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "created_at": "2018-02-09T20:51:14Z", + "updated_at": "2018-02-09T20:51:14Z", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, "/enterprises/{enterprise}/license-sync-status": { "get": { "summary": "Get a license sync status", @@ -58117,7 +59154,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58164,7 +59201,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58211,7 +59248,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58258,7 +59295,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58305,7 +59342,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58621,7 +59658,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -58642,7 +59679,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -59475,7 +60512,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59522,7 +60559,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59569,7 +60606,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59616,7 +60653,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59663,7 +60700,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59984,7 +61021,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -60002,7 +61039,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -60939,7 +61976,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -60986,7 +62023,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61033,7 +62070,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61080,7 +62117,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61127,7 +62164,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61448,7 +62485,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -61466,7 +62503,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -62772,7 +63809,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62819,7 +63856,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62866,7 +63903,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62913,7 +63950,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62960,7 +63997,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -63272,7 +64309,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -63293,7 +64330,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -64126,7 +65163,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64173,7 +65210,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64220,7 +65257,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64267,7 +65304,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64314,7 +65351,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64635,7 +65672,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -64653,7 +65690,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -64928,7 +65965,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -65109,41 +66146,39 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "repository", - "source_type": "Enterprise", - "source": "my-enterprise", - "enforcement": "active", - "conditions": { - "organization_name": { - "include": [ - "important_organization" - ] - }, - "repository_name": { - "include": [ - "~ALL" - ] - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] }, - "rules": [ - { - "type": "repository_delete" - } - ] - } + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ] } - ] + } } } } @@ -84848,6 +85883,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -117023,6 +118065,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -146187,7 +147236,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record": { "post": { "summary": "Create an artifact deployment record", - "description": "Create or update deployment records for an artifact associated with an organization.\nThis endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment.", + "description": "Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.", "tags": [ "orgs" ], @@ -146266,7 +147315,7 @@ }, "deployment_name": { "type": "string", - "description": "The name of the deployment." + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n" }, "tags": { "type": "object", @@ -155547,6 +156596,16 @@ ], "default": "disabled" }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, "code_scanning_options": { "type": [ "object", @@ -157349,6 +158408,15 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -164493,7 +165561,7 @@ }, "cli": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "description": "The organization policy for allowing or disallowing Copilot CLI.", "enum": [ "enabled", "disabled", @@ -185345,6 +186413,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -192289,7 +193364,6 @@ "subject_type": "installation", "subject_id": 954453, "subject_name": "GitHub Actions", - "integration_id": 124345, "total_request_count": 544665, "rate_limited_request_count": 13, "last_request_timestamp": "2024-09-18T15:43:03Z", @@ -193905,14 +194979,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -195076,14 +196142,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -264833,7 +265891,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -264880,7 +265938,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -264927,7 +265985,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -264974,7 +266032,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -265021,7 +266079,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266116,7 +267174,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266163,7 +267221,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266210,7 +267268,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266257,7 +267315,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266304,7 +267362,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267489,7 +268547,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267536,7 +268594,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267583,7 +268641,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267630,7 +268688,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267677,7 +268735,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269520,7 +270578,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269567,7 +270625,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269614,7 +270672,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269661,7 +270719,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269708,7 +270766,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270828,7 +271886,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270875,7 +271933,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270922,7 +271980,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270969,7 +272027,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -271016,7 +272074,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272197,7 +273255,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272244,7 +273302,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272291,7 +273349,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272338,7 +273396,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272385,7 +273443,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -273013,7 +274071,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -273194,61 +274252,59 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -444268,6 +445324,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -463240,14 +464303,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -474738,6 +475793,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -475665,6 +476727,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -476530,6 +477599,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -501774,6 +502850,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -502675,6 +503758,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -557267,6 +558357,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -629102,7 +630199,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629175,7 +630272,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629248,7 +630345,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629321,7 +630418,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629394,7 +630491,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630848,7 +631945,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630895,7 +631992,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630942,7 +632039,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630989,7 +632086,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -631036,7 +632133,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -631998,7 +633095,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632045,7 +633142,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632092,7 +633189,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632139,7 +633236,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632186,7 +633283,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633361,7 +634458,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633408,7 +634505,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633455,7 +634552,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633502,7 +634599,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633549,7 +634646,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635411,7 +636508,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635458,7 +636555,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635505,7 +636602,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635552,7 +636649,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635599,7 +636696,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636576,7 +637673,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636623,7 +637720,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636670,7 +637767,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636717,7 +637814,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636764,7 +637861,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -637935,7 +639032,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -637982,7 +639079,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638029,7 +639126,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638076,7 +639173,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638123,7 +639220,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638759,7 +639856,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -638949,51 +640046,49 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -731121,14 +732216,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -784772,6 +785859,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -795691,6 +796785,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -806620,6 +807721,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -812253,14 +813361,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -844269,6 +845369,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -855184,6 +856291,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -890316,7 +891430,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -890371,7 +891484,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -895292,7 +896404,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -895347,7 +896458,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -900266,7 +901376,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -900321,7 +901430,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -905257,7 +906365,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -905312,7 +906419,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -906035,13 +907141,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -908834,13 +909933,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -911626,13 +912718,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -965913,13 +966998,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -985860,666 +986938,652 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "production_environment": { - "type": "boolean" - }, - "ref": { - "type": "string" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "task": { - "type": "string" - }, - "transient_environment": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "sha", - "ref", - "task", - "payload", - "original_environment", - "environment", - "description", - "creator", - "created_at", - "updated_at", - "statuses_url", - "repository_url" - ] - }, - "deployment_status": { - "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses).", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "description": { - "description": "The optional human-readable description added to the status.", - "type": "string" - }, - "environment": { - "type": "string" - }, - "environment_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "log_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "pull_request_review_thread", - "merge_queue_entry", - "workflow_job", - "merge_group", - "secret_scanning_alert_location" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "production_environment": { + "type": "boolean" + }, + "ref": { + "type": "string" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "task": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", + "created_at", + "updated_at", + "statuses_url", + "repository_url" + ] + }, + "deployment_status": { + "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "deployment_url": { + "type": "string", + "format": "uri" + }, + "description": { + "description": "The optional human-readable description added to the status.", + "type": "string" + }, + "environment": { + "type": "string" + }, + "environment_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "log_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job", + "merge_group", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { "type": "string", "enum": [ "read", @@ -1079215,14 +1080279,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1082346,14 +1083402,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1085382,14 +1086430,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1088418,14 +1089458,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1091588,14 +1092620,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1094765,14 +1095789,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1099937,14 +1100953,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1102235,411 +1103243,9047 @@ "type": "string" }, "performed_via_github_app": { - "anyOf": [ - { - "type": "null" + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the comment.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "issues": { - "type": "string" + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "checks": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "metadata": { - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "contents": { - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "deployments": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 ] } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, "reactions": { @@ -1102784,7 +1112428,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1102799,6 +1112444,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -1103850,8 +1113502,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "secret_scanning_alerts": { @@ -1103896,13 +1113547,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1106400,6 +1116044,7 @@ }, "required": [ "action", + "changes", "issue", "comment", "repository", @@ -1106426,11 +1116071,11 @@ } } }, - "issue-comment-deleted": { + "issue-comment-pinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, @@ -1106497,13 +1116142,13 @@ "content": { "application/json": { "schema": { - "title": "issue_comment deleted event", + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "pinned" ] }, "comment": { @@ -1107109,6 +1116754,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -1110735,11 +1120387,11 @@ } } }, - "issue-comment-edited": { + "issue-comment-unpinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, @@ -1110806,33 +1120458,15 @@ "content": { "application/json": { "schema": { - "title": "issue_comment edited event", + "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "unpinned" ] }, - "changes": { - "description": "The changes to the comment.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "comment": { "title": "issue comment", "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", @@ -1111436,6 +1121070,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -1112173,9 +1121814,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -1112430,8 +1122069,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -1113264,6 +1122902,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -1115036,7 +1124677,6 @@ }, "required": [ "action", - "changes", "issue", "comment", "repository", @@ -1151040,13 +1160680,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1154489,13 +1164122,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1158146,13 +1167772,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1161618,13 +1171237,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1165249,13 +1174861,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1168734,13 +1178339,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1172258,13 +1181856,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1175695,13 +1185286,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1179183,13 +1188767,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1181375,13 +1190952,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1184812,13 +1194382,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1188287,13 +1197850,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1191579,13 +1201135,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1193787,13 +1203336,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1197231,13 +1206773,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1200844,13 +1210379,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1204288,13 +1213816,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1207810,13 +1217331,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1211213,13 +1220727,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1214656,13 +1224163,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1556104,7 +1565604,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556151,7 +1565651,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556198,7 +1565698,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556245,7 +1565745,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556292,7 +1565792,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559405,7 +1568905,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559452,7 +1568952,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559499,7 +1568999,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559546,7 +1569046,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559593,7 +1569093,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562706,7 +1572206,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562753,7 +1572253,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562800,7 +1572300,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562847,7 +1572347,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562894,7 +1572394,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563780,7 +1573280,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563827,7 +1573327,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563874,7 +1573374,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563921,7 +1573421,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563968,7 +1573468,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564682,7 +1574182,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564729,7 +1574229,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564776,7 +1574276,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564823,7 +1574323,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564870,7 +1574370,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565587,7 +1575087,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565634,7 +1575134,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565681,7 +1575181,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565728,7 +1575228,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565775,7 +1575275,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1570709,6 +1580209,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } @@ -1575021,6 +1584522,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 41aacf5f5..72203a49e 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -913,7 +913,7 @@ paths: - subscriptions_url - type - url - type: &424 + type: &425 type: string description: The type of credit the user is receiving. enum: @@ -2665,13 +2665,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 @@ -13542,7 +13535,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &512 + instances_url: &513 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13578,7 +13571,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &513 + dismissed_reason: &514 type: - string - 'null' @@ -13589,14 +13582,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &514 + dismissed_comment: &515 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &515 + rule: &516 type: object properties: id: @@ -13657,7 +13650,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &516 + tool: &517 type: object properties: name: *109 @@ -13668,26 +13661,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *110 - most_recent_instance: &517 + most_recent_instance: &518 type: object properties: - ref: &510 + ref: &511 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &527 + analysis_key: &528 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &528 + environment: &529 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &529 + category: &530 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13701,7 +13694,7 @@ paths: properties: text: type: string - location: &530 + location: &531 type: object description: Describe a region within a file for the alert. properties: @@ -13722,7 +13715,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &531 + items: &532 type: - string - 'null' @@ -16104,7 +16097,7 @@ paths: parent: anyOf: - type: 'null' - - &371 + - &372 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -17497,7 +17490,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &568 + - &569 name: has in: query description: |- @@ -17614,7 +17607,7 @@ paths: - direct - transitive - - security_advisory: &569 + security_advisory: &570 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17850,7 +17843,7 @@ paths: dismissal. maxLength: 280 fixed_at: *134 - auto_dismissed_at: &570 + auto_dismissed_at: &571 type: - string - 'null' @@ -17858,7 +17851,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &571 + dismissal_request: &572 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -18851,6 +18844,80 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles + "/enterprises/{enterprise}/installation": + get: + summary: Get an enterprise installation for the authenticated app + description: |- + Enables an authenticated GitHub App to find its installation on a particular enterprise. + + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/get-enterprise-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app + parameters: + - *39 + responses: + '200': + description: Response + content: + application/json: + schema: *20 + examples: + default: &352 + value: + id: 1 + account: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/orgs/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + repository_selection: all + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + client_id: Iv1.ab1112223334445c + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + created_at: '2018-02-09T20:51:14Z' + updated_at: '2018-02-09T20:51:14Z' + single_file_name: config.yml + has_multiple_single_files: true + single_file_paths: + - config.yml + - ".github/issue_TEMPLATE.md" + app_slug: github-actions + suspended_at: + suspended_by: + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: apps + subcategory: apps "/enterprises/{enterprise}/license-sync-status": get: summary: Get a license sync status @@ -19060,7 +19127,7 @@ paths: - name - created_on examples: - default: &428 + default: &429 value: total_count: 2 network_configurations: @@ -19285,7 +19352,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *39 - - &429 + - &430 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -19297,7 +19364,7 @@ paths: description: Response content: application/json: - schema: &430 + schema: &431 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -19336,7 +19403,7 @@ paths: - subnet_id - region examples: - default: &431 + default: &432 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -20185,7 +20252,7 @@ paths: required: true content: application/json: - schema: &402 + schema: &403 title: Custom Property Set Payload description: Custom property set payload type: object @@ -20890,7 +20957,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 @@ -20926,7 +20994,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 @@ -20962,7 +21031,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 @@ -20998,7 +21068,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 @@ -21034,7 +21105,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 @@ -21288,7 +21360,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -21301,7 +21373,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '201': description: Response @@ -21379,7 +21451,7 @@ paths: conditions: anyOf: - *156 - - &406 + - &407 title: Organization ruleset conditions type: object description: |- @@ -21544,7 +21616,7 @@ paths: value: id: 21 name: super cool ruleset - target: repository + target: branch source_type: Enterprise source: my-enterprise enforcement: active @@ -21556,7 +21628,7 @@ paths: include: - "~ALL" rules: - - type: repository_delete + - type: deletion node_id: RRS_lACkVXNlcgQB _links: self: @@ -21659,7 +21731,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -21672,7 +21744,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '200': description: Response @@ -21766,13 +21838,13 @@ paths: type: string format: date-time examples: - default: &409 + default: &410 value: - version_id: 3 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 @@ -21819,7 +21891,7 @@ paths: description: Response content: application/json: - schema: &410 + schema: &411 allOf: - *189 - type: object @@ -21832,11 +21904,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 @@ -21874,7 +21946,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *39 - - &411 + - &412 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -21885,7 +21957,7 @@ paths: enum: - open - resolved - - &412 + - &413 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -21895,7 +21967,7 @@ paths: required: false schema: type: string - - &413 + - &414 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -21904,7 +21976,7 @@ paths: required: false schema: type: string - - &414 + - &415 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -21923,7 +21995,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &415 + - &416 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -21939,7 +22011,7 @@ paths: - *17 - *106 - *107 - - &416 + - &417 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21948,7 +22020,7 @@ paths: required: false schema: type: string - - &417 + - &418 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21957,7 +22029,7 @@ paths: schema: type: boolean default: false - - &418 + - &419 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21966,7 +22038,7 @@ paths: schema: type: boolean default: false - - &419 + - &420 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21982,7 +22054,7 @@ paths: application/json: schema: type: array - items: &420 + items: &421 type: object properties: number: *124 @@ -22412,7 +22484,7 @@ paths: - type: 'null' - *4 examples: - default: &421 + default: &422 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -22621,7 +22693,7 @@ paths: description: Response content: application/json: - schema: &422 + schema: &423 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -22708,7 +22780,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *191 examples: - default: &423 + default: &424 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -22844,7 +22916,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &425 + - &426 name: advanced_security_product in: query description: | @@ -22864,7 +22936,7 @@ paths: description: Success content: application/json: - schema: &426 + schema: &427 type: object properties: total_advanced_security_committers: @@ -22927,7 +22999,7 @@ paths: required: - repositories examples: - default: &427 + default: &428 value: total_advanced_security_committers: 2 total_count: 2 @@ -26287,7 +26359,7 @@ paths: milestone: anyOf: - type: 'null' - - &392 + - &393 title: Milestone description: A collection of related issues and pull requests. @@ -26459,7 +26531,7 @@ paths: timeline_url: type: string format: uri - type: &358 + type: &359 title: Issue Type description: The type of issue. type: @@ -26779,6 +26851,9 @@ paths: - type: 'null' - *5 reactions: *215 + pin: + anyOf: + - type: 'null' required: - id - node_id @@ -30016,7 +30091,7 @@ paths: - closed - all default: open - - &361 + - &362 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -30067,7 +30142,7 @@ paths: type: array items: *213 examples: - default: &362 + default: &363 value: - id: 1 node_id: MDU6SXNzdWUx @@ -31478,14 +31553,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &439 + - &440 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &440 + - &441 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -31547,7 +31622,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &445 + '301': &446 description: Moved permanently content: application/json: @@ -31960,7 +32035,7 @@ paths: type: boolean examples: - false - security_and_analysis: &403 + security_and_analysis: &404 type: - object - 'null' @@ -34203,7 +34278,7 @@ paths: type: integer repository_cache_usages: type: array - items: &452 + items: &453 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -37379,7 +37454,7 @@ paths: description: Response content: application/json: - schema: &472 + schema: &473 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -37414,7 +37489,7 @@ paths: - key_id - key examples: - default: &473 + default: &474 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -37827,7 +37902,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *85 - - &457 + - &458 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -38379,8 +38454,19 @@ paths: post: summary: Create an artifact deployment record description: |- - Create or update deployment records for an artifact associated with an organization. - This endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment. + Create or update deployment records for an artifact associated + with an organization. + This endpoint allows you to record information about a specific + artifact, such as its name, digest, environments, cluster, and + deployment. + The deployment name has to be uniqe within a cluster (i.e a + combination of logical, physical environment and cluster) as it + identifies unique deployment. + Multiple requests for the same combination of logical, physical + environment, cluster and deployment name will only create one + record, successive request will update the existing record. + This allows for a stable tracking of a deployment where the actual + deployed artifact can change over time. tags: - orgs operationId: orgs/create-artifact-deployment-record @@ -38439,7 +38525,10 @@ paths: description: The deployment cluster. deployment_name: type: string - description: The name of the deployment. + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a cluster, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. tags: type: object description: The tags associated with the deployment. @@ -39480,7 +39569,7 @@ paths: initiator: type: string examples: - default: &486 + default: &487 value: attestations: - bundle: @@ -40402,7 +40491,7 @@ paths: be returned. in: query required: false - schema: &511 + schema: &512 type: string description: Severity of a code scanning alert. enum: @@ -40645,6 +40734,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: *116 code_scanning_default_setup: type: string @@ -41002,6 +41100,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 @@ -41427,7 +41533,7 @@ paths: type: integer codespaces: type: array - items: &363 + items: &364 type: object title: Codespace description: A codespace. @@ -41462,7 +41568,7 @@ paths: machine: anyOf: - type: 'null' - - &543 + - &544 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -41749,7 +41855,7 @@ paths: - pulls_url - recent_folders examples: - default: &364 + default: &365 value: total_count: 3 codespaces: @@ -42414,7 +42520,7 @@ paths: - updated_at - visibility examples: - default: &544 + default: &545 value: total_count: 2 secrets: @@ -42452,7 +42558,7 @@ paths: description: Response content: application/json: - schema: &545 + schema: &546 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -42487,7 +42593,7 @@ paths: - key_id - key examples: - default: &546 + default: &547 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -42519,7 +42625,7 @@ paths: application/json: schema: *316 examples: - default: &548 + default: &549 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -42890,7 +42996,7 @@ paths: cli: type: string description: The organization policy for allowing or disallowing - Copilot in the CLI. + Copilot CLI. enum: - enabled - disabled @@ -44398,7 +44504,7 @@ paths: description: Response content: application/json: - schema: &574 + schema: &575 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -44417,7 +44523,7 @@ paths: - key_id - key examples: - default: &575 + default: &576 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -44747,7 +44853,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *85 - - &583 + - &584 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -44755,7 +44861,7 @@ paths: required: false schema: type: string - - &584 + - &585 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -44763,7 +44869,7 @@ paths: required: false schema: type: string - - &585 + - &586 name: time_period description: |- The time period to filter by. @@ -44779,7 +44885,7 @@ paths: - week - month default: month - - &586 + - &587 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -44804,7 +44910,7 @@ paths: application/json: schema: type: array - items: &587 + items: &588 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -44967,7 +45073,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &588 + default: &589 value: - id: 21 number: 42 @@ -45085,7 +45191,7 @@ paths: application/json: schema: type: array - items: &589 + items: &590 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -45208,7 +45314,7 @@ paths: examples: - https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &590 + default: &591 value: - id: 21 number: 42 @@ -45310,7 +45416,7 @@ paths: application/json: schema: type: array - items: &591 + items: &592 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -45437,7 +45543,7 @@ paths: examples: - https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &592 + default: &593 value: - id: 21 number: 42 @@ -45525,7 +45631,7 @@ paths: application/json: schema: type: array - items: &373 + items: &374 title: Package description: A software package type: object @@ -45596,7 +45702,7 @@ paths: - created_at - updated_at examples: - default: &374 + default: &375 value: - id: 197 name: hello_docker @@ -45783,7 +45889,7 @@ paths: description: Response content: application/json: - schema: &436 + schema: &437 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -45873,7 +45979,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &437 + default: &438 value: group_id: '123' group_name: Octocat admins @@ -45928,7 +46034,7 @@ paths: description: Response content: application/json: - schema: &434 + schema: &435 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -45968,7 +46074,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &435 + default: &436 value: groups: - group_id: '123' @@ -46012,7 +46118,7 @@ paths: application/json: schema: type: array - items: &355 + items: &356 title: Organization Invitation description: Organization Invitation type: object @@ -46066,7 +46172,7 @@ paths: - invitation_teams_url - node_id examples: - default: &356 + default: &357 value: - id: 1 login: monalisa @@ -46133,7 +46239,7 @@ paths: application/json: schema: type: array - items: &404 + items: &405 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -46147,7 +46253,7 @@ paths: - name - description examples: - default: &405 + default: &406 value: - name: add_assignee description: Assign or remove a user @@ -46950,7 +47056,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' @@ -47297,53 +47402,7 @@ paths: application/json: schema: *20 examples: - default: &623 - value: - id: 1 - account: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/orgs/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - received_events_url: https://api.github.com/users/github/received_events - type: Organization - site_admin: false - repository_selection: all - access_tokens_url: https://api.github.com/app/installations/1/access_tokens - repositories_url: https://api.github.com/installation/repositories - html_url: https://github.com/organizations/github/settings/installations/1 - app_id: 1 - client_id: Iv1.ab1112223334445c - target_id: 1 - target_type: Organization - permissions: - checks: write - metadata: read - contents: read - events: - - push - - pull_request - created_at: '2018-02-09T20:51:14Z' - updated_at: '2018-02-09T20:51:14Z' - single_file_name: config.yml - has_multiple_single_files: true - single_file_paths: - - config.yml - - ".github/issue_TEMPLATE.md" - app_slug: github-actions - suspended_at: - suspended_by: + default: *352 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47463,12 +47522,12 @@ paths: application/json: schema: anyOf: - - &353 + - &354 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &352 + limit: &353 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -47496,7 +47555,7 @@ paths: properties: {} additionalProperties: false examples: - default: &354 + default: &355 value: limit: collaborators_only origin: organization @@ -47531,7 +47590,7 @@ paths: duration type: object properties: - limit: *352 + limit: *353 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -47556,9 +47615,9 @@ paths: description: Response content: application/json: - schema: *353 + schema: *354 examples: - default: *354 + default: *355 '422': *15 x-github: githubCloudOnly: false @@ -47636,9 +47695,9 @@ paths: application/json: schema: type: array - items: *355 + items: *356 examples: - default: *356 + default: *357 headers: Link: *45 '404': *6 @@ -47716,7 +47775,7 @@ paths: description: Response content: application/json: - schema: *355 + schema: *356 examples: default: value: @@ -47773,7 +47832,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - *85 - - &357 + - &358 name: invitation_id description: The unique identifier of the invitation. in: path @@ -47807,7 +47866,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - *85 - - *357 + - *358 - *17 - *19 responses: @@ -47819,7 +47878,7 @@ paths: type: array items: *302 examples: - default: &372 + default: &373 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -47862,7 +47921,7 @@ paths: application/json: schema: type: array - items: *358 + items: *359 examples: default: value: @@ -47950,9 +48009,9 @@ paths: description: Response content: application/json: - schema: *358 + schema: *359 examples: - default: &359 + default: &360 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -47985,7 +48044,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *85 - - &360 + - &361 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -48041,9 +48100,9 @@ paths: description: Response content: application/json: - schema: *358 + schema: *359 examples: - default: *359 + default: *360 '404': *6 '422': *7 x-github: @@ -48068,7 +48127,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *85 - - *360 + - *361 responses: '204': description: Response @@ -48131,7 +48190,7 @@ paths: - closed - all default: open - - *361 + - *362 - name: type description: Can be the name of an issue type. in: query @@ -48162,7 +48221,7 @@ paths: type: array items: *213 examples: - default: *362 + default: *363 headers: Link: *45 '404': *6 @@ -48321,9 +48380,9 @@ paths: type: integer codespaces: type: array - items: *363 + items: *364 examples: - default: *364 + default: *365 '304': *35 '500': *38 '401': *23 @@ -48350,7 +48409,7 @@ paths: parameters: - *85 - *137 - - &365 + - &366 name: codespace_name in: path required: true @@ -48385,15 +48444,15 @@ paths: parameters: - *85 - *137 - - *365 + - *366 responses: '200': description: Response content: application/json: - schema: *363 + schema: *364 examples: - default: &542 + default: &543 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -48649,7 +48708,7 @@ paths: description: Response content: application/json: - schema: &366 + schema: &367 title: Org Membership description: Org Membership type: object @@ -48718,7 +48777,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &367 + response-if-user-has-an-active-admin-membership-with-organization: &368 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -48819,9 +48878,9 @@ paths: description: Response content: application/json: - schema: *366 + schema: *367 examples: - response-if-user-already-had-membership-with-organization: *367 + response-if-user-already-had-membership-with-organization: *368 '422': *15 '403': *27 x-github: @@ -48893,7 +48952,7 @@ paths: application/json: schema: type: array - items: &368 + items: &369 title: Migration description: A migration. type: object @@ -49231,7 +49290,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *369 examples: default: value: @@ -49410,7 +49469,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - *85 - - &369 + - &370 name: migration_id description: The unique identifier of the migration. in: path @@ -49438,7 +49497,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *368 + schema: *369 examples: default: value: @@ -49608,7 +49667,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - *85 - - *369 + - *370 responses: '302': description: Response @@ -49630,7 +49689,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *85 - - *369 + - *370 responses: '204': description: Response @@ -49654,7 +49713,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - *85 - - *369 + - *370 - &788 name: repo_name description: repo_name parameter @@ -49683,7 +49742,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *85 - - *369 + - *370 - *17 - *19 responses: @@ -49695,7 +49754,7 @@ paths: type: array items: *273 examples: - default: &379 + default: &380 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -49904,7 +49963,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &370 + items: &371 title: Organization Role description: Organization roles type: object @@ -50113,7 +50172,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *371 examples: default: value: @@ -50343,7 +50402,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *371 examples: default: value: @@ -50440,7 +50499,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *371 examples: default: value: @@ -50599,7 +50658,7 @@ paths: parent: anyOf: - type: 'null' - - *371 + - *372 type: description: The ownership type of the team type: string @@ -50632,7 +50691,7 @@ paths: - type - parent examples: - default: *372 + default: *373 headers: Link: *45 '404': @@ -50691,7 +50750,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *371 + items: *372 name: type: - string @@ -51037,9 +51096,9 @@ paths: application/json: schema: type: array - items: *373 + items: *374 examples: - default: *374 + default: *375 '403': *27 '401': *23 '400': &791 @@ -51064,7 +51123,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &375 + - &376 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -51082,7 +51141,7 @@ paths: - docker - nuget - container - - &376 + - &377 name: package_name description: The name of the package. in: path @@ -51095,7 +51154,7 @@ paths: description: Response content: application/json: - schema: *373 + schema: *374 examples: default: value: @@ -51147,8 +51206,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *375 - *376 + - *377 - *85 responses: '204': @@ -51181,8 +51240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *375 - *376 + - *377 - *85 - name: token description: package token @@ -51215,8 +51274,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *375 - *376 + - *377 - *85 - *19 - *17 @@ -51237,7 +51296,7 @@ paths: application/json: schema: type: array - items: &377 + items: &378 title: Package Version description: A version of a software package type: object @@ -51372,10 +51431,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *375 - *376 + - *377 - *85 - - &378 + - &379 name: package_version_id description: Unique identifier of the package version. in: path @@ -51387,7 +51446,7 @@ paths: description: Response content: application/json: - schema: *377 + schema: *378 examples: default: value: @@ -51423,10 +51482,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *375 - *376 + - *377 - *85 - - *378 + - *379 responses: '204': description: Response @@ -51458,10 +51517,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *375 - *376 + - *377 - *85 - - *378 + - *379 responses: '204': description: Response @@ -51491,7 +51550,7 @@ paths: - *85 - *17 - *19 - - &380 + - &381 name: sort description: The property by which to sort the results. in: query @@ -51502,7 +51561,7 @@ paths: - created_at default: created_at - *108 - - &381 + - &382 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -51514,7 +51573,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &382 + - &383 name: repository description: The name of the repository to use to filter the results. in: query @@ -51523,7 +51582,7 @@ paths: type: string examples: - Hello-World - - &383 + - &384 name: permission description: The permission to use to filter the results. in: query @@ -51532,7 +51591,7 @@ paths: type: string examples: - issues_read - - &384 + - &385 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -51542,7 +51601,7 @@ paths: schema: type: string format: date-time - - &385 + - &386 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -51552,7 +51611,7 @@ paths: schema: type: string format: date-time - - &386 + - &387 name: token_id description: The ID of the token in: query @@ -51871,7 +51930,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -51897,14 +51956,14 @@ paths: - *85 - *17 - *19 - - *380 - - *108 - *381 + - *108 - *382 - *383 - *384 - *385 - *386 + - *387 responses: '500': *38 '422': *15 @@ -52188,7 +52247,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -52230,7 +52289,7 @@ paths: type: integer configurations: type: array - items: &387 + items: &388 title: Organization private registry description: Private registry configuration for an organization type: object @@ -52526,7 +52585,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &388 + org-private-registry-with-selected-visibility: &389 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -52624,9 +52683,9 @@ paths: description: The specified private registry configuration for the organization content: application/json: - schema: *387 + schema: *388 examples: - default: *388 + default: *389 '404': *6 x-github: githubCloudOnly: false @@ -52794,7 +52853,7 @@ paths: application/json: schema: type: array - items: &389 + items: &390 title: Projects v2 Project description: A projects v2 project type: object @@ -52953,7 +53012,7 @@ paths: - deleted_at - deleted_by examples: - default: &390 + default: &391 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -53056,7 +53115,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &391 + - &392 name: project_number description: The project's number. in: path @@ -53069,9 +53128,9 @@ paths: description: Response content: application/json: - schema: *389 + schema: *390 examples: - default: *390 + default: *391 headers: Link: *45 '304': *35 @@ -53094,7 +53153,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *85 - - *391 + - *392 requestBody: required: true description: Details of the draft item to create in the project. @@ -53128,7 +53187,7 @@ paths: description: Response content: application/json: - schema: &396 + schema: &397 title: Projects v2 Item description: An item belonging to a project type: object @@ -53142,7 +53201,7 @@ paths: content: oneOf: - *213 - - &557 + - &558 title: Pull Request Simple description: Pull Request Simple type: object @@ -53262,7 +53321,7 @@ paths: milestone: anyOf: - type: 'null' - - *392 + - *393 active_lock_reason: type: - string @@ -53361,7 +53420,7 @@ paths: _links: type: object properties: - comments: &393 + comments: &394 title: Link description: Hypermedia Link type: object @@ -53370,13 +53429,13 @@ paths: type: string required: - href - commits: *393 - statuses: *393 - html: *393 - issue: *393 - review_comments: *393 - review_comment: *393 - self: *393 + commits: *394 + statuses: *394 + html: *394 + issue: *394 + review_comments: *394 + review_comment: *394 + self: *394 required: - comments - commits @@ -53489,7 +53548,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &395 + content_type: &396 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -53533,7 +53592,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &397 + draft_issue: &398 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -53607,7 +53666,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *391 + - *392 - *85 - *17 - *106 @@ -53619,7 +53678,7 @@ paths: application/json: schema: type: array - items: &394 + items: &395 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -53899,7 +53958,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *391 + - *392 - *85 requestBody: required: true @@ -54082,7 +54141,7 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *394 + schema: *395 examples: text_field: &815 value: @@ -54190,7 +54249,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *391 + - *392 - &820 name: field_id description: The unique identifier of the field. @@ -54204,7 +54263,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *395 examples: default: &821 value: @@ -54262,7 +54321,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *391 + - *392 - *85 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -54295,7 +54354,7 @@ paths: application/json: schema: type: array - items: &398 + items: &399 title: Projects v2 Item description: An item belonging to a project type: object @@ -54312,7 +54371,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: *395 + content_type: *396 content: type: - object @@ -54362,7 +54421,7 @@ paths: - updated_at - archived_at examples: - default: &399 + default: &400 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -55059,7 +55118,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - *85 - - *391 + - *392 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -55129,22 +55188,22 @@ paths: description: Response content: application/json: - schema: *396 + schema: *397 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *397 + value: *398 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *397 + value: *398 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *397 + value: *398 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *397 + value: *398 '304': *35 '403': *27 '401': *23 @@ -55164,9 +55223,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *391 + - *392 - *85 - - &400 + - &401 name: item_id description: The unique identifier of the project item. in: path @@ -55192,9 +55251,9 @@ paths: description: Response content: application/json: - schema: *398 + schema: *399 examples: - default: *399 + default: *400 headers: Link: *45 '304': *35 @@ -55215,9 +55274,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *391 + - *392 - *85 - - *400 + - *401 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -55290,13 +55349,13 @@ paths: description: Response content: application/json: - schema: *398 + schema: *399 examples: - text_field: *399 - number_field: *399 - date_field: *399 - single_select_field: *399 - iteration_field: *399 + text_field: *400 + number_field: *400 + date_field: *400 + single_select_field: *400 + iteration_field: *400 '401': *23 '403': *27 '404': *6 @@ -55316,9 +55375,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *391 + - *392 - *85 - - *400 + - *401 responses: '204': description: Response @@ -55342,7 +55401,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *85 - - *391 + - *392 requestBody: required: true content: @@ -55520,7 +55579,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &401 + value: &402 value: id: 1 number: 1 @@ -55566,10 +55625,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *401 + value: *402 roadmap_view: summary: Response for creating a roadmap view - value: *401 + value: *402 '304': *35 '403': *27 '401': *23 @@ -55597,7 +55656,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-project-view parameters: - - *391 + - *392 - *85 - &822 name: view_number @@ -55631,9 +55690,9 @@ paths: application/json: schema: type: array - items: *398 + items: *399 examples: - default: *399 + default: *400 headers: Link: *45 '304': *35 @@ -55797,7 +55856,7 @@ paths: required: true content: application/json: - schema: *402 + schema: *403 examples: default: value: @@ -56165,7 +56224,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -56369,7 +56428,7 @@ paths: description: Response content: application/json: - schema: &444 + schema: &445 title: Full Repository description: Full Repository type: object @@ -56834,7 +56893,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &562 + code_of_conduct: &563 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -56864,7 +56923,7 @@ paths: - key - name - html_url - security_and_analysis: *403 + security_and_analysis: *404 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -56948,7 +57007,7 @@ paths: - network_count - subscribers_count examples: - default: &446 + default: &447 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -57474,9 +57533,9 @@ paths: application/json: schema: type: array - items: *404 + items: *405 examples: - default: *405 + default: *406 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57593,11 +57652,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *163 - conditions: *406 + conditions: *407 rules: type: array description: An array of rules within the ruleset. - items: &408 + items: &409 title: Repository Rule type: object description: A repository rule. @@ -57662,7 +57721,7 @@ paths: application/json: schema: *185 examples: - default: &407 + default: &408 value: id: 21 name: super cool ruleset @@ -58054,7 +58113,7 @@ paths: application/json: schema: *185 examples: - default: *407 + default: *408 '404': *6 '500': *38 put: @@ -58103,11 +58162,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *163 - conditions: *406 + conditions: *407 rules: description: An array of rules within the ruleset. type: array - items: *408 + items: *409 examples: default: value: @@ -58144,7 +58203,7 @@ paths: application/json: schema: *185 examples: - default: *407 + default: *408 '404': *6 '500': *38 delete: @@ -58203,7 +58262,7 @@ paths: type: array items: *189 examples: - default: *409 + default: *410 '404': *6 '500': *38 x-github: @@ -58240,15 +58299,15 @@ paths: description: Response content: application/json: - schema: *410 + schema: *411 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 @@ -58303,11 +58362,11 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *85 - - *411 - *412 - *413 - *414 - *415 + - *416 - *108 - *19 - *17 @@ -58331,10 +58390,10 @@ paths: required: false schema: type: string - - *416 - *417 - *418 - *419 + - *420 responses: '200': description: Response @@ -58342,9 +58401,9 @@ paths: application/json: schema: type: array - items: *420 + items: *421 examples: - default: *421 + default: *422 headers: Link: *45 '404': *6 @@ -58379,9 +58438,9 @@ paths: description: Response content: application/json: - schema: *422 + schema: *423 examples: - default: *423 + default: *424 '403': *27 '404': *6 patch: @@ -58778,7 +58837,7 @@ paths: login: type: string description: The username of the user credited. - type: *424 + type: *425 credits_detailed: type: - array @@ -58789,7 +58848,7 @@ paths: type: object properties: user: *4 - type: *424 + type: *425 state: type: string description: The state of the user's acceptance of the @@ -59240,9 +59299,9 @@ paths: application/json: schema: type: array - items: *371 + items: *372 examples: - default: *372 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59324,7 +59383,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *85 - - *425 + - *426 - *17 - *19 responses: @@ -59332,9 +59391,9 @@ paths: description: Success content: application/json: - schema: *426 + schema: *427 examples: - default: *427 + default: *428 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -59617,7 +59676,7 @@ paths: type: array items: *142 examples: - default: *428 + default: *429 headers: Link: *45 x-github: @@ -59820,15 +59879,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *85 - - *429 + - *430 responses: '200': description: Response content: application/json: - schema: *430 + schema: *431 examples: - default: *431 + default: *432 headers: Link: *45 x-github: @@ -59866,7 +59925,7 @@ paths: description: Response content: application/json: - schema: &441 + schema: &442 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -59918,7 +59977,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &442 + default: &443 value: groups: - group_id: '123' @@ -60032,7 +60091,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 headers: Link: *45 '403': *27 @@ -60126,7 +60185,7 @@ paths: description: Response content: application/json: - schema: &432 + schema: &433 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -60200,7 +60259,7 @@ paths: parent: anyOf: - type: 'null' - - *371 + - *372 members_count: type: integer examples: @@ -60525,7 +60584,7 @@ paths: - repos_count - organization examples: - default: &433 + default: &434 value: id: 1 node_id: MDQ6VGVhbTE= @@ -60602,9 +60661,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '404': *6 x-github: githubCloudOnly: false @@ -60689,16 +60748,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '201': description: Response content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '404': *6 '422': *15 '403': *27 @@ -60754,9 +60813,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *435 examples: - default: *435 + default: *436 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -60800,9 +60859,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *437 examples: - default: *437 + default: *438 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -60857,9 +60916,9 @@ paths: application/json: schema: type: array - items: *355 + items: *356 examples: - default: *356 + default: *357 headers: Link: *45 x-github: @@ -60943,7 +61002,7 @@ paths: description: Response content: application/json: - schema: &438 + schema: &439 title: Team Membership description: Team Membership type: object @@ -61034,7 +61093,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *439 examples: response-if-users-membership-with-team-is-now-pending: &770 summary: Response if user's membership with team is now pending @@ -61112,7 +61171,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -61143,8 +61202,8 @@ paths: parameters: - *85 - *210 - - *439 - *440 + - *441 responses: '200': description: Alternative response with repository permissions @@ -61793,8 +61852,8 @@ paths: parameters: - *85 - *210 - - *439 - *440 + - *441 requestBody: required: false content: @@ -61841,8 +61900,8 @@ paths: parameters: - *85 - *210 - - *439 - *440 + - *441 responses: '204': description: Response @@ -61875,9 +61934,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *442 examples: - default: *442 + default: *443 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -61943,7 +62002,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *442 examples: default: value: @@ -62142,7 +62201,7 @@ paths: resources: type: object properties: - core: &443 + core: &444 title: Rate Limit type: object properties: @@ -62159,21 +62218,21 @@ paths: - remaining - reset - used - graphql: *443 - search: *443 - code_search: *443 - source_import: *443 - integration_manifest: *443 - code_scanning_upload: *443 - actions_runner_registration: *443 - scim: *443 - dependency_snapshots: *443 - dependency_sbom: *443 - code_scanning_autofix: *443 + graphql: *444 + search: *444 + code_search: *444 + source_import: *444 + integration_manifest: *444 + code_scanning_upload: *444 + actions_runner_registration: *444 + scim: *444 + dependency_snapshots: *444 + dependency_sbom: *444 + code_scanning_autofix: *444 required: - core - search - rate: *443 + rate: *444 required: - rate - resources @@ -62278,14 +62337,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: *444 + schema: *445 examples: default-response: summary: Default response @@ -62790,7 +62849,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *445 + '301': *446 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62808,8 +62867,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -63067,10 +63126,10 @@ paths: description: Response content: application/json: - schema: *444 + schema: *445 examples: - default: *446 - '307': &447 + default: *447 + '307': &448 description: Temporary Redirect content: application/json: @@ -63099,8 +63158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -63122,7 +63181,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *447 + '307': *448 '404': *6 '409': *117 x-github: @@ -63146,11 +63205,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *439 - *440 + - *441 - *17 - *19 - - &464 + - &465 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -63173,7 +63232,7 @@ paths: type: integer artifacts: type: array - items: &448 + items: &449 title: Artifact description: An artifact type: object @@ -63268,7 +63327,7 @@ paths: - expires_at - updated_at examples: - default: &465 + default: &466 value: total_count: 2 artifacts: @@ -63329,9 +63388,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *439 - *440 - - &449 + - *441 + - &450 name: artifact_id description: The unique identifier of the artifact. in: path @@ -63343,7 +63402,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *449 examples: default: value: @@ -63381,9 +63440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *439 - *440 - - *449 + - *441 + - *450 responses: '204': description: Response @@ -63407,9 +63466,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *439 - *440 - - *449 + - *441 + - *450 - name: archive_format in: path required: true @@ -63448,14 +63507,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: &450 + schema: &451 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -63489,13 +63548,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: application/json: - schema: *450 + schema: *451 examples: selected_actions: *42 responses: @@ -63524,14 +63583,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: &451 + schema: &452 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -63565,13 +63624,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: application/json: - schema: *451 + schema: *452 examples: selected_actions: *44 responses: @@ -63602,14 +63661,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: *452 + schema: *453 examples: default: value: @@ -63635,11 +63694,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *439 - *440 + - *441 - *17 - *19 - - &453 + - &454 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -63673,7 +63732,7 @@ paths: description: Response content: application/json: - schema: &454 + schema: &455 title: Repository actions caches description: Repository actions caches type: object @@ -63723,7 +63782,7 @@ paths: - total_count - actions_caches examples: - default: &455 + default: &456 value: total_count: 1 actions_caches: @@ -63755,23 +63814,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *439 - *440 + - *441 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *453 + - *454 responses: '200': description: Response content: application/json: - schema: *454 + schema: *455 examples: - default: *455 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63791,8 +63850,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *439 - *440 + - *441 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -63823,9 +63882,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *439 - *440 - - &456 + - *441 + - &457 name: job_id description: The unique identifier of the job. in: path @@ -63837,7 +63896,7 @@ paths: description: Response content: application/json: - schema: &468 + schema: &469 title: Job description: Information of a job execution in a workflow run type: object @@ -64184,9 +64243,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *439 - *440 - - *456 + - *441 + - *457 responses: '302': description: Response @@ -64214,9 +64273,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *439 - *440 - - *456 + - *441 + - *457 requestBody: required: false content: @@ -64262,8 +64321,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Status response @@ -64313,8 +64372,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -64377,8 +64436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -64396,7 +64455,7 @@ paths: type: integer secrets: type: array - items: &470 + items: &471 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -64417,7 +64476,7 @@ paths: - created_at - updated_at examples: - default: &471 + default: &472 value: total_count: 2 secrets: @@ -64450,9 +64509,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *439 - *440 - - *457 + - *441 + - *458 - *19 responses: '200': @@ -64469,7 +64528,7 @@ paths: type: integer variables: type: array - items: &474 + items: &475 title: Actions Variable type: object properties: @@ -64503,7 +64562,7 @@ paths: - created_at - updated_at examples: - default: &475 + default: &476 value: total_count: 2 variables: @@ -64536,8 +64595,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64546,7 +64605,7 @@ paths: schema: type: object properties: - enabled: &458 + enabled: &459 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *58 @@ -64581,8 +64640,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -64593,7 +64652,7 @@ paths: schema: type: object properties: - enabled: *458 + enabled: *459 allowed_actions: *58 sha_pinning_required: *59 required: @@ -64626,14 +64685,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: &459 + schema: &460 type: object properties: access_level: @@ -64651,7 +64710,7 @@ paths: required: - access_level examples: - default: &460 + default: &461 value: access_level: organization x-github: @@ -64676,15 +64735,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: application/json: - schema: *459 + schema: *460 examples: - default: *460 + default: *461 responses: '204': description: Response @@ -64708,8 +64767,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64739,8 +64798,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Empty response for successful settings update @@ -64774,8 +64833,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64802,8 +64861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -64837,8 +64896,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64866,8 +64925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -64898,8 +64957,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64930,8 +64989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -64963,8 +65022,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -64993,8 +65052,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Success response @@ -65034,8 +65093,8 @@ paths: in: query schema: type: string - - *439 - *440 + - *441 - *17 - *19 responses: @@ -65079,8 +65138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -65112,8 +65171,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -65187,8 +65246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *439 - *440 + - *441 responses: '201': description: Response @@ -65224,8 +65283,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *439 - *440 + - *441 responses: '201': description: Response @@ -65255,8 +65314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 responses: '200': @@ -65286,8 +65345,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *439 - *440 + - *441 - *73 responses: '204': @@ -65314,8 +65373,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 responses: '200': *79 @@ -65340,8 +65399,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 requestBody: required: true @@ -65390,8 +65449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 requestBody: required: true @@ -65441,8 +65500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 responses: '200': *280 @@ -65472,8 +65531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *439 - *440 + - *441 - *73 - *281 responses: @@ -65503,9 +65562,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *439 - *440 - - &478 + - *441 + - &479 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -65513,7 +65572,7 @@ paths: required: false schema: type: string - - &479 + - &480 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -65521,7 +65580,7 @@ paths: required: false schema: type: string - - &480 + - &481 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -65530,7 +65589,7 @@ paths: required: false schema: type: string - - &481 + - &482 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -65557,7 +65616,7 @@ paths: - pending - *17 - *19 - - &482 + - &483 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -65566,7 +65625,7 @@ paths: schema: type: string format: date-time - - &461 + - &462 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -65575,13 +65634,13 @@ paths: schema: type: boolean default: false - - &483 + - &484 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &484 + - &485 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -65604,7 +65663,7 @@ paths: type: integer workflow_runs: type: array - items: &462 + items: &463 title: Workflow Run description: An invocation of a workflow type: object @@ -65782,7 +65841,7 @@ paths: head_commit: anyOf: - type: 'null' - - &506 + - &507 title: Simple Commit description: A commit. type: object @@ -65897,7 +65956,7 @@ paths: - workflow_url - pull_requests examples: - default: &485 + default: &486 value: total_count: 1 workflow_runs: @@ -66133,24 +66192,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *439 - *440 - - &463 + - *441 + - &464 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *461 + - *462 responses: '200': description: Response content: application/json: - schema: *462 + schema: *463 examples: - default: &466 + default: &467 value: id: 30433642 name: Build @@ -66391,9 +66450,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '204': description: Response @@ -66416,9 +66475,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '200': description: Response @@ -66546,9 +66605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '201': description: Response @@ -66581,12 +66640,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *439 - *440 - - *463 + - *441 + - *464 - *17 - *19 - - *464 + - *465 responses: '200': description: Response @@ -66602,9 +66661,9 @@ paths: type: integer artifacts: type: array - items: *448 + items: *449 examples: - default: *465 + default: *466 headers: Link: *45 x-github: @@ -66628,25 +66687,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *439 - *440 - - *463 - - &467 + - *441 + - *464 + - &468 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *461 + - *462 responses: '200': description: Response content: application/json: - schema: *462 + schema: *463 examples: - default: *466 + default: *467 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66669,10 +66728,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *439 - *440 - - *463 - - *467 + - *441 + - *464 + - *468 - *17 - *19 responses: @@ -66690,9 +66749,9 @@ paths: type: integer jobs: type: array - items: *468 + items: *469 examples: - default: &469 + default: &470 value: total_count: 1 jobs: @@ -66805,10 +66864,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *439 - *440 - - *463 - - *467 + - *441 + - *464 + - *468 responses: '302': description: Response @@ -66836,9 +66895,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '202': description: Response @@ -66871,9 +66930,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 requestBody: required: true content: @@ -66940,9 +66999,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '202': description: Response @@ -66975,9 +67034,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -67007,9 +67066,9 @@ paths: type: integer jobs: type: array - items: *468 + items: *469 examples: - default: *469 + default: *470 headers: Link: *45 x-github: @@ -67034,9 +67093,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '302': description: Response @@ -67063,9 +67122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '204': description: Response @@ -67092,9 +67151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '200': description: Response @@ -67163,7 +67222,7 @@ paths: items: type: object properties: - type: &593 + type: &594 type: string description: The type of reviewer. enum: @@ -67249,9 +67308,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 requestBody: required: true content: @@ -67301,7 +67360,7 @@ paths: application/json: schema: type: array - items: &578 + items: &579 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -67413,7 +67472,7 @@ paths: - created_at - updated_at examples: - default: &579 + default: &580 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -67469,9 +67528,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *439 - *440 - - *463 + - *441 + - *464 requestBody: required: false content: @@ -67516,9 +67575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *439 - *440 - - *463 + - *441 + - *464 requestBody: required: false content: @@ -67573,9 +67632,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *439 - *440 - - *463 + - *441 + - *464 responses: '200': description: Response @@ -67712,8 +67771,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -67731,9 +67790,9 @@ paths: type: integer secrets: type: array - items: *470 + items: *471 examples: - default: *471 + default: *472 headers: Link: *45 x-github: @@ -67758,16 +67817,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: *472 + schema: *473 examples: - default: *473 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67789,17 +67848,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '200': description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: &606 + default: &607 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -67825,8 +67884,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 requestBody: required: true @@ -67884,8 +67943,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '204': @@ -67911,9 +67970,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *439 - *440 - - *457 + - *441 + - *458 - *19 responses: '200': @@ -67930,9 +67989,9 @@ paths: type: integer variables: type: array - items: *474 + items: *475 examples: - default: *475 + default: *476 headers: Link: *45 x-github: @@ -67955,8 +68014,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -68008,17 +68067,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *439 - *440 + - *441 - *286 responses: '200': description: Response content: application/json: - schema: *474 + schema: *475 examples: - default: &607 + default: &608 value: name: USERNAME value: octocat @@ -68044,8 +68103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *439 - *440 + - *441 - *286 requestBody: required: true @@ -68088,8 +68147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *439 - *440 + - *441 - *286 responses: '204': @@ -68115,8 +68174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -68134,7 +68193,7 @@ paths: type: integer workflows: type: array - items: &476 + items: &477 title: Workflow description: A GitHub Actions workflow type: object @@ -68252,9 +68311,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *439 - *440 - - &477 + - *441 + - &478 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -68269,7 +68328,7 @@ paths: description: Response content: application/json: - schema: *476 + schema: *477 examples: default: value: @@ -68302,9 +68361,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *439 - *440 - - *477 + - *441 + - *478 responses: '204': description: Response @@ -68329,9 +68388,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *439 - *440 - - *477 + - *441 + - *478 responses: '204': description: Response @@ -68382,9 +68441,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *439 - *440 - - *477 + - *441 + - *478 responses: '204': description: Response @@ -68411,19 +68470,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *439 - *440 - - *477 + - *441 - *478 - *479 - *480 - *481 + - *482 - *17 - *19 - - *482 - - *461 - *483 + - *462 - *484 + - *485 responses: '200': description: Response @@ -68439,9 +68498,9 @@ paths: type: integer workflow_runs: type: array - items: *462 + items: *463 examples: - default: *485 + default: *486 headers: Link: *45 x-github: @@ -68474,9 +68533,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *439 - *440 - - *477 + - *441 + - *478 responses: '200': description: Response @@ -68537,8 +68596,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *439 - *440 + - *441 - *108 - *17 - *106 @@ -68706,8 +68765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -68744,8 +68803,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *439 - *440 + - *441 - name: assignee in: path required: true @@ -68781,8 +68840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -68894,8 +68953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations parameters: - - *439 - *440 + - *441 - *17 - *106 - *107 @@ -68952,7 +69011,7 @@ paths: initiator: type: string examples: - default: *486 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68972,8 +69031,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -68981,7 +69040,7 @@ paths: application/json: schema: type: array - items: &487 + items: &488 title: Autolink reference description: An autolink reference. type: object @@ -69040,8 +69099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -69080,9 +69139,9 @@ paths: description: response content: application/json: - schema: *487 + schema: *488 examples: - default: &488 + default: &489 value: id: 1 key_prefix: TICKET- @@ -69113,9 +69172,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *439 - *440 - - &489 + - *441 + - &490 name: autolink_id description: The unique identifier of the autolink. in: path @@ -69127,9 +69186,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *488 examples: - default: *488 + default: *489 '404': *6 x-github: githubCloudOnly: false @@ -69149,9 +69208,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *439 - *440 - - *489 + - *441 + - *490 responses: '204': description: Response @@ -69175,8 +69234,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response if Dependabot is enabled @@ -69226,8 +69285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -69248,8 +69307,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -69269,8 +69328,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *439 - *440 + - *441 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -69308,7 +69367,7 @@ paths: - url protected: type: boolean - protection: &491 + protection: &492 title: Branch Protection description: Branch Protection type: object @@ -69351,7 +69410,7 @@ paths: required: - contexts - checks - enforce_admins: &494 + enforce_admins: &495 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -69368,7 +69427,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &496 + required_pull_request_reviews: &497 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -69452,7 +69511,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &493 + restrictions: &494 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -69745,9 +69804,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *439 - *440 - - &492 + - *441 + - &493 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -69761,14 +69820,14 @@ paths: description: Response content: application/json: - schema: &502 + schema: &503 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &553 + commit: &554 title: Commit description: Commit type: object @@ -69807,7 +69866,7 @@ paths: author: anyOf: - type: 'null' - - &490 + - &491 title: Git User description: Metaproperties for Git author/committer information. @@ -69829,7 +69888,7 @@ paths: committer: anyOf: - type: 'null' - - *490 + - *491 message: type: string examples: @@ -69853,7 +69912,7 @@ paths: required: - sha - url - verification: &613 + verification: &614 title: Verification type: object properties: @@ -69933,7 +69992,7 @@ paths: type: integer files: type: array - items: &564 + items: &565 title: Diff Entry description: Diff Entry type: object @@ -70029,7 +70088,7 @@ paths: - self protected: type: boolean - protection: *491 + protection: *492 protection_url: type: string format: uri @@ -70138,7 +70197,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *445 + '301': *446 '404': *6 x-github: githubCloudOnly: false @@ -70160,15 +70219,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *491 + schema: *492 examples: default: value: @@ -70362,9 +70421,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -70624,7 +70683,7 @@ paths: url: type: string format: uri - required_status_checks: &499 + required_status_checks: &500 title: Status Check Policy description: Status Check Policy type: object @@ -70783,7 +70842,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *493 + restrictions: *494 required_conversation_resolution: type: object properties: @@ -70895,9 +70954,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -70922,17 +70981,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *494 + schema: *495 examples: - default: &495 + default: &496 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -70954,17 +71013,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *494 + schema: *495 examples: - default: *495 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70983,9 +71042,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -71010,17 +71069,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *496 + schema: *497 examples: - default: &497 + default: &498 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -71116,9 +71175,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -71216,9 +71275,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *497 examples: - default: *497 + default: *498 '422': *15 x-github: githubCloudOnly: false @@ -71239,9 +71298,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -71268,17 +71327,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *494 + schema: *495 examples: - default: &498 + default: &499 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -71301,17 +71360,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *494 + schema: *495 examples: - default: *498 + default: *499 '404': *6 x-github: githubCloudOnly: false @@ -71331,9 +71390,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -71358,17 +71417,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *499 + schema: *500 examples: - default: &500 + default: &501 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -71394,9 +71453,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -71448,9 +71507,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *500 examples: - default: *500 + default: *501 '404': *6 '422': *15 x-github: @@ -71472,9 +71531,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -71498,9 +71557,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response @@ -71534,9 +71593,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -71603,9 +71662,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -71669,9 +71728,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: content: application/json: @@ -71737,15 +71796,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response content: application/json: - schema: *493 + schema: *494 examples: default: value: @@ -71836,9 +71895,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '204': description: Response @@ -71861,9 +71920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response @@ -71873,7 +71932,7 @@ paths: type: array items: *5 examples: - default: &501 + default: &502 value: - id: 1 slug: octoapp @@ -71930,9 +71989,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -71966,7 +72025,7 @@ paths: type: array items: *5 examples: - default: *501 + default: *502 '422': *15 x-github: githubCloudOnly: false @@ -71987,9 +72046,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72023,7 +72082,7 @@ paths: type: array items: *5 examples: - default: *501 + default: *502 '422': *15 x-github: githubCloudOnly: false @@ -72044,9 +72103,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72080,7 +72139,7 @@ paths: type: array items: *5 examples: - default: *501 + default: *502 '422': *15 x-github: githubCloudOnly: false @@ -72102,9 +72161,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response @@ -72114,7 +72173,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 '404': *6 x-github: githubCloudOnly: false @@ -72134,9 +72193,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -72174,7 +72233,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 '422': *15 x-github: githubCloudOnly: false @@ -72195,9 +72254,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: false content: @@ -72235,7 +72294,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 '422': *15 x-github: githubCloudOnly: false @@ -72256,9 +72315,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: content: application/json: @@ -72295,7 +72354,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 '422': *15 x-github: githubCloudOnly: false @@ -72317,9 +72376,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *439 - *440 - - *492 + - *441 + - *493 responses: '200': description: Response @@ -72353,9 +72412,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72413,9 +72472,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72473,9 +72532,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72535,9 +72594,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *439 - *440 - - *492 + - *441 + - *493 requestBody: required: true content: @@ -72559,7 +72618,7 @@ paths: description: Response content: application/json: - schema: *502 + schema: *503 examples: default: value: @@ -72673,8 +72732,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *439 - *440 + - *441 - *101 - *102 - *103 @@ -72710,8 +72769,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *439 - *440 + - *441 - name: bypass_request_number in: path required: true @@ -72784,8 +72843,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *439 - *440 + - *441 - *101 - *102 - *103 @@ -72825,8 +72884,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *439 - *440 + - *441 - name: bypass_request_number in: path required: true @@ -72896,8 +72955,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *439 - *440 + - *441 - name: bypass_request_number in: path required: true @@ -72968,8 +73027,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *439 - *440 + - *441 - name: bypass_response_id in: path required: true @@ -73002,8 +73061,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -73282,7 +73341,7 @@ paths: description: Response content: application/json: - schema: &503 + schema: &504 title: CheckRun description: A check performed on the code of a given code change type: object @@ -73705,9 +73764,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *439 - *440 - - &504 + - *441 + - &505 name: check_run_id description: The unique identifier of the check run. in: path @@ -73719,9 +73778,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *504 examples: - default: &505 + default: &506 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -73821,9 +73880,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *439 - *440 - - *504 + - *441 + - *505 requestBody: required: true content: @@ -74063,9 +74122,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *504 examples: - default: *505 + default: *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74085,9 +74144,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *439 - *440 - - *504 + - *441 + - *505 - *17 - *19 responses: @@ -74197,9 +74256,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *439 - *440 - - *504 + - *441 + - *505 responses: '201': description: Response @@ -74243,8 +74302,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -74266,7 +74325,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &507 + schema: &508 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -74364,7 +74423,7 @@ paths: - string - 'null' format: date-time - head_commit: *506 + head_commit: *507 latest_check_runs_count: type: integer check_runs_url: @@ -74392,7 +74451,7 @@ paths: - check_runs_url - pull_requests examples: - default: &508 + default: &509 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -74683,9 +74742,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *507 + schema: *508 examples: - default: *508 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74704,8 +74763,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -75014,9 +75073,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *439 - *440 - - &509 + - *441 + - &510 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -75028,9 +75087,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: *508 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75053,17 +75112,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *439 - *440 - - *509 - - &559 + - *441 + - *510 + - &560 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &560 + - &561 name: status description: Returns check runs with the specified `status`. in: query @@ -75102,9 +75161,9 @@ paths: type: integer check_runs: type: array - items: *503 + items: *504 examples: - default: &561 + default: &562 value: total_count: 1 check_runs: @@ -75206,9 +75265,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *439 - *440 - - *509 + - *441 + - *510 responses: '201': description: Response @@ -75241,21 +75300,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *439 - *440 + - *441 - *306 - *307 - *19 - *17 - - &525 + - &526 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *510 - - &526 + schema: *511 + - &527 name: pr description: The number of the pull request for the results you want to list. in: query @@ -75286,7 +75345,7 @@ paths: be returned. in: query required: false - schema: *511 + schema: *512 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -75310,7 +75369,7 @@ paths: updated_at: *132 url: *129 html_url: *130 - instances_url: *512 + instances_url: *513 state: *111 fixed_at: *134 dismissed_by: @@ -75318,11 +75377,11 @@ paths: - type: 'null' - *4 dismissed_at: *133 - dismissed_reason: *513 - dismissed_comment: *514 - rule: *515 - tool: *516 - most_recent_instance: *517 + dismissed_reason: *514 + dismissed_comment: *515 + rule: *516 + tool: *517 + most_recent_instance: *518 dismissal_approved_by: anyOf: - type: 'null' @@ -75445,7 +75504,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &518 + '403': &519 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -75472,9 +75531,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *439 - *440 - - &519 + - *441 + - &520 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -75488,7 +75547,7 @@ paths: description: Response content: application/json: - schema: &520 + schema: &521 type: object properties: number: *124 @@ -75496,7 +75555,7 @@ paths: updated_at: *132 url: *129 html_url: *130 - instances_url: *512 + instances_url: *513 state: *111 fixed_at: *134 dismissed_by: @@ -75504,8 +75563,8 @@ paths: - type: 'null' - *4 dismissed_at: *133 - dismissed_reason: *513 - dismissed_comment: *514 + dismissed_reason: *514 + dismissed_comment: *515 rule: type: object properties: @@ -75567,8 +75626,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *516 - most_recent_instance: *517 + tool: *517 + most_recent_instance: *518 dismissal_approved_by: anyOf: - type: 'null' @@ -75664,7 +75723,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -75684,9 +75743,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 requestBody: required: true content: @@ -75701,8 +75760,8 @@ paths: enum: - open - dismissed - dismissed_reason: *513 - dismissed_comment: *514 + dismissed_reason: *514 + dismissed_comment: *515 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -75730,7 +75789,7 @@ paths: description: Response content: application/json: - schema: *520 + schema: *521 examples: default: value: @@ -75806,7 +75865,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &524 + '403': &525 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -75833,15 +75892,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 responses: '200': description: Response content: application/json: - schema: &521 + schema: &522 type: object properties: status: @@ -75868,13 +75927,13 @@ paths: - description - started_at examples: - default: &522 + default: &523 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &523 + '400': &524 description: Bad Request content: application/json: @@ -75885,7 +75944,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -75910,29 +75969,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 responses: '200': description: OK content: application/json: - schema: *521 + schema: *522 examples: - default: *522 + default: *523 '202': description: Accepted content: application/json: - schema: *521 + schema: *522 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *523 + '400': *524 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -75964,9 +76023,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 requestBody: required: false content: @@ -76012,8 +76071,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *523 - '403': *524 + '400': *524 + '403': *525 '404': *6 '422': description: Unprocessable Entity @@ -76037,13 +76096,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 - *19 - *17 - - *525 - *526 + - *527 responses: '200': description: Response @@ -76054,10 +76113,10 @@ paths: items: type: object properties: - ref: *510 - analysis_key: *527 - environment: *528 - category: *529 + ref: *511 + analysis_key: *528 + environment: *529 + category: *530 state: type: - string @@ -76074,7 +76133,7 @@ paths: properties: text: type: string - location: *530 + location: *531 html_url: type: string classifications: @@ -76082,7 +76141,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *531 + items: *532 examples: default: value: @@ -76121,7 +76180,7 @@ paths: end_column: 50 classifications: - source - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -76155,25 +76214,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *439 - *440 + - *441 - *306 - *307 - *19 - *17 - - *526 + - *527 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *510 + schema: *511 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &532 + schema: &533 type: string description: An identifier for the upload. examples: @@ -76195,23 +76254,23 @@ paths: application/json: schema: type: array - items: &533 + items: &534 type: object properties: - ref: *510 - commit_sha: &541 + ref: *511 + commit_sha: &542 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *527 + analysis_key: *528 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *529 + category: *530 error: type: string examples: @@ -76236,8 +76295,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *532 - tool: *516 + sarif_id: *533 + tool: *517 deletable: type: boolean warning: @@ -76299,7 +76358,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -76335,8 +76394,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *439 - *440 + - *441 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -76349,7 +76408,7 @@ paths: description: Response content: application/json: - schema: *533 + schema: *534 examples: response: summary: application/json response @@ -76403,7 +76462,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *518 + '403': *519 '404': *6 '422': description: Response if analysis could not be processed @@ -76490,8 +76549,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *439 - *440 + - *441 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -76547,7 +76606,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *524 + '403': *525 '404': *6 '503': *190 x-github: @@ -76569,8 +76628,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -76578,7 +76637,7 @@ paths: application/json: schema: type: array - items: &534 + items: &535 title: CodeQL Database description: A CodeQL database. type: object @@ -76690,7 +76749,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -76719,8 +76778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *439 - *440 + - *441 - name: language in: path description: The language of the CodeQL database. @@ -76732,7 +76791,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *535 examples: default: value: @@ -76764,9 +76823,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &566 + '302': &567 description: Found - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -76788,8 +76847,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *439 - *440 + - *441 - name: language in: path description: The language of the CodeQL database. @@ -76799,7 +76858,7 @@ paths: responses: '204': description: Response - '403': *524 + '403': *525 '404': *6 '503': *190 x-github: @@ -76827,8 +76886,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -76837,7 +76896,7 @@ paths: type: object additionalProperties: false properties: - language: &535 + language: &536 type: string description: The language targeted by the CodeQL query enum: @@ -76917,7 +76976,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &539 + schema: &540 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -76927,7 +76986,7 @@ paths: description: The ID of the variant analysis. controller_repo: *118 actor: *4 - query_language: *535 + query_language: *536 query_pack_url: type: string description: The download url for the query pack. @@ -76975,7 +77034,7 @@ paths: items: type: object properties: - repository: &536 + repository: &537 title: Repository Identifier description: Repository Identifier type: object @@ -77017,7 +77076,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &540 + analysis_status: &541 type: string description: The new status of the CodeQL variant analysis repository task. @@ -77049,7 +77108,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &537 + access_mismatch_repos: &538 type: object properties: repository_count: @@ -77064,7 +77123,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *536 + items: *537 required: - repository_count - repositories @@ -77087,8 +77146,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *537 - over_limit_repos: *537 + no_codeql_db_repos: *538 + over_limit_repos: *538 required: - access_mismatch_repos - not_found_repos @@ -77104,7 +77163,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &538 + value: &539 summary: Default response value: id: 1 @@ -77250,10 +77309,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *538 + value: *539 repository_lists: summary: Response for a successful variant analysis submission - value: *538 + value: *539 '404': *6 '422': description: Unable to process variant analysis submission @@ -77281,8 +77340,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *439 - *440 + - *441 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -77294,9 +77353,9 @@ paths: description: Response content: application/json: - schema: *539 + schema: *540 examples: - default: *538 + default: *539 '404': *6 '503': *190 x-github: @@ -77319,7 +77378,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *439 + - *440 - name: repo in: path description: The name of the controller repository. @@ -77354,7 +77413,7 @@ paths: type: object properties: repository: *118 - analysis_status: *540 + analysis_status: *541 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -77479,8 +77538,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -77573,7 +77632,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *518 + '403': *519 '404': *6 '503': *190 x-github: @@ -77594,8 +77653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -77689,7 +77748,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *524 + '403': *525 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -77760,8 +77819,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -77769,7 +77828,7 @@ paths: schema: type: object properties: - commit_sha: *541 + commit_sha: *542 ref: type: string description: |- @@ -77829,7 +77888,7 @@ paths: schema: type: object properties: - id: *532 + id: *533 url: type: string description: The REST API URL for checking the status of the upload. @@ -77843,7 +77902,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *524 + '403': *525 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -77866,8 +77925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *439 - *440 + - *441 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -77915,7 +77974,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *518 + '403': *519 '404': description: Not Found if the sarif id does not match any upload '503': *190 @@ -77940,8 +77999,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -78022,8 +78081,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *439 - *440 + - *441 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -78151,8 +78210,8 @@ paths: parameters: - *17 - *19 - - *439 - *440 + - *441 responses: '200': description: Response @@ -78168,7 +78227,7 @@ paths: type: integer codespaces: type: array - items: *363 + items: *364 examples: default: value: @@ -78466,8 +78525,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -78531,17 +78590,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '400': *14 '401': *23 '403': *27 @@ -78570,8 +78629,8 @@ paths: parameters: - *17 - *19 - - *439 - *440 + - *441 responses: '200': description: Response @@ -78635,8 +78694,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *439 - *440 + - *441 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -78673,7 +78732,7 @@ paths: type: integer machines: type: array - items: *543 + items: *544 examples: default: &779 value: @@ -78715,8 +78774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *439 - *440 + - *441 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -78803,8 +78862,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *439 - *440 + - *441 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -78873,8 +78932,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -78892,7 +78951,7 @@ paths: type: integer secrets: type: array - items: &547 + items: &548 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -78913,7 +78972,7 @@ paths: - created_at - updated_at examples: - default: *544 + default: *545 headers: Link: *45 x-github: @@ -78936,16 +78995,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: *545 + schema: *546 examples: - default: *546 + default: *547 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -78965,17 +79024,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '200': description: Response content: application/json: - schema: *547 + schema: *548 examples: - default: *548 + default: *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78995,8 +79054,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 requestBody: required: true @@ -79049,8 +79108,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '204': @@ -79079,8 +79138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *439 - *440 + - *441 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -79118,7 +79177,7 @@ paths: application/json: schema: type: array - items: &549 + items: &550 title: Collaborator description: Collaborator type: object @@ -79311,8 +79370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *439 - *440 + - *441 - *137 responses: '204': @@ -79359,8 +79418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *439 - *440 + - *441 - *137 requestBody: required: false @@ -79615,8 +79674,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *439 - *440 + - *441 - *137 responses: '204': @@ -79648,8 +79707,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *439 - *440 + - *441 - *137 responses: '200': @@ -79670,7 +79729,7 @@ paths: user: anyOf: - type: 'null' - - *549 + - *550 required: - permission - role_name @@ -79724,8 +79783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -79735,7 +79794,7 @@ paths: application/json: schema: type: array - items: &550 + items: &551 title: Commit Comment description: Commit Comment type: object @@ -79793,7 +79852,7 @@ paths: - created_at - updated_at examples: - default: &555 + default: &556 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79852,17 +79911,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *439 - *440 + - *441 - *228 responses: '200': description: Response content: application/json: - schema: *550 + schema: *551 examples: - default: &556 + default: &557 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79919,8 +79978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -79943,7 +80002,7 @@ paths: description: Response content: application/json: - schema: *550 + schema: *551 examples: default: value: @@ -79994,8 +80053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *439 - *440 + - *441 - *228 responses: '204': @@ -80017,8 +80076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *439 - *440 + - *441 - *228 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -80045,7 +80104,7 @@ paths: application/json: schema: type: array - items: &551 + items: &552 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -80134,8 +80193,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -80168,9 +80227,9 @@ paths: description: Reaction exists content: application/json: - schema: *551 + schema: *552 examples: - default: &552 + default: &553 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -80199,9 +80258,9 @@ paths: description: Reaction created content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '422': *15 x-github: githubCloudOnly: false @@ -80223,8 +80282,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *439 - *440 + - *441 - *228 - &631 name: reaction_id @@ -80281,8 +80340,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *439 - *440 + - *441 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -80338,7 +80397,7 @@ paths: application/json: schema: type: array - items: *553 + items: *554 examples: default: &677 value: @@ -80434,9 +80493,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *439 - *440 - - &554 + - *441 + - &555 name: commit_sha description: The SHA of the commit. in: path @@ -80508,9 +80567,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *439 - *440 - - *554 + - *441 + - *555 - *17 - *19 responses: @@ -80520,9 +80579,9 @@ paths: application/json: schema: type: array - items: *550 + items: *551 examples: - default: *555 + default: *556 headers: Link: *45 x-github: @@ -80550,9 +80609,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *439 - *440 - - *554 + - *441 + - *555 requestBody: required: true content: @@ -80587,9 +80646,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *551 examples: - default: *556 + default: *557 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -80617,9 +80676,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *439 - *440 - - *554 + - *441 + - *555 - *17 - *19 responses: @@ -80629,7 +80688,7 @@ paths: application/json: schema: type: array - items: *557 + items: *558 examples: default: &669 value: @@ -81168,11 +81227,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *439 - *440 + - *441 - *19 - *17 - - &558 + - &559 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -81187,7 +81246,7 @@ paths: description: Response content: application/json: - schema: *553 + schema: *554 examples: default: &655 value: @@ -81302,11 +81361,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *439 - *440 - - *558 + - *441 - *559 - *560 + - *561 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -81340,9 +81399,9 @@ paths: type: integer check_runs: type: array - items: *503 + items: *504 examples: - default: *561 + default: *562 headers: Link: *45 x-github: @@ -81367,9 +81426,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *439 - *440 - - *558 + - *441 + - *559 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -81377,7 +81436,7 @@ paths: schema: type: integer example: 1 - - *559 + - *560 - *17 - *19 responses: @@ -81395,7 +81454,7 @@ paths: type: integer check_suites: type: array - items: *507 + items: *508 examples: default: value: @@ -81595,9 +81654,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *439 - *440 - - *558 + - *441 + - *559 - *17 - *19 responses: @@ -81799,9 +81858,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *439 - *440 - - *558 + - *441 + - *559 - *17 - *19 responses: @@ -81892,7 +81951,7 @@ paths: site_admin: false headers: Link: *45 - '301': *445 + '301': *446 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81920,8 +81979,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -81954,11 +82013,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *562 + - *563 code_of_conduct_file: anyOf: - type: 'null' - - &563 + - &564 title: Community Health File type: object properties: @@ -81978,19 +82037,19 @@ paths: contributing: anyOf: - type: 'null' - - *563 + - *564 readme: anyOf: - type: 'null' - - *563 + - *564 issue_template: anyOf: - type: 'null' - - *563 + - *564 pull_request_template: anyOf: - type: 'null' - - *563 + - *564 required: - code_of_conduct - code_of_conduct_file @@ -82119,8 +82178,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *439 - *440 + - *441 - *19 - *17 - name: basehead @@ -82168,8 +82227,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *553 - merge_base_commit: *553 + base_commit: *554 + merge_base_commit: *554 status: type: string enum: @@ -82193,10 +82252,10 @@ paths: - 6 commits: type: array - items: *553 + items: *554 files: type: array - items: *564 + items: *565 required: - url - html_url @@ -82482,8 +82541,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *439 - *440 + - *441 - name: path description: path parameter in: path @@ -82636,7 +82695,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &565 + response-if-content-is-a-file: &566 summary: Response if content is a file value: type: file @@ -82991,7 +83050,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *565 + response-if-content-is-a-file: *566 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -83060,7 +83119,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *566 + '302': *567 '304': *35 x-github: githubCloudOnly: false @@ -83083,8 +83142,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *439 - *440 + - *441 - name: path description: path parameter in: path @@ -83179,7 +83238,7 @@ paths: description: Response content: application/json: - schema: &567 + schema: &568 title: File Commit description: File Commit type: object @@ -83335,7 +83394,7 @@ paths: description: Response content: application/json: - schema: *567 + schema: *568 examples: example-for-creating-a-file: value: @@ -83389,7 +83448,7 @@ paths: schema: oneOf: - *3 - - &608 + - &609 description: Repository rule violation was detected type: object properties: @@ -83442,8 +83501,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *439 - *440 + - *441 - name: path description: path parameter in: path @@ -83504,7 +83563,7 @@ paths: description: Response content: application/json: - schema: *567 + schema: *568 examples: default: value: @@ -83559,8 +83618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *439 - *440 + - *441 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -83684,8 +83743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *439 - *440 + - *441 - *321 - *322 - *323 @@ -83697,7 +83756,7 @@ paths: schema: type: string - *325 - - *568 + - *569 - *326 - *327 - *108 @@ -83718,7 +83777,7 @@ paths: application/json: schema: type: array - items: &572 + items: &573 type: object description: A Dependabot alert. properties: @@ -83768,7 +83827,7 @@ paths: - direct - transitive - - security_advisory: *569 + security_advisory: *570 security_vulnerability: *128 url: *129 html_url: *130 @@ -83799,8 +83858,8 @@ paths: dismissal. maxLength: 280 fixed_at: *134 - auto_dismissed_at: *570 - dismissal_request: *571 + auto_dismissed_at: *571 + dismissal_request: *572 required: - number - state @@ -84030,9 +84089,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *439 - *440 - - &573 + - *441 + - &574 name: alert_number in: path description: |- @@ -84047,7 +84106,7 @@ paths: description: Response content: application/json: - schema: *572 + schema: *573 examples: default: value: @@ -84160,9 +84219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *439 - *440 - - *573 + - *441 + - *574 requestBody: required: true content: @@ -84207,7 +84266,7 @@ paths: description: Response content: application/json: - schema: *572 + schema: *573 examples: default: value: @@ -84336,8 +84395,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -84355,7 +84414,7 @@ paths: type: integer secrets: type: array - items: &576 + items: &577 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -84409,16 +84468,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: *574 + schema: *575 examples: - default: *575 + default: *576 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84438,15 +84497,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '200': description: Response content: application/json: - schema: *576 + schema: *577 examples: default: value: @@ -84472,8 +84531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 requestBody: required: true @@ -84526,8 +84585,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *439 - *440 + - *441 - *283 responses: '204': @@ -84550,8 +84609,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *439 - *440 + - *441 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -84725,8 +84784,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -84986,8 +85045,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -85070,7 +85129,7 @@ paths: - version - url additionalProperties: false - metadata: &577 + metadata: &578 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -85109,7 +85168,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *577 + metadata: *578 resolved: type: object description: A collection of resolved package dependencies. @@ -85123,7 +85182,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *577 + metadata: *578 relationship: type: string description: A notation of whether a dependency is requested @@ -85256,8 +85315,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *439 - *440 + - *441 - name: sha description: The SHA recorded at creation time. in: query @@ -85298,9 +85357,9 @@ paths: application/json: schema: type: array - items: *578 + items: *579 examples: - default: *579 + default: *580 headers: Link: *45 x-github: @@ -85366,8 +85425,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -85449,7 +85508,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *579 examples: simple-example: summary: Simple example @@ -85522,9 +85581,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *439 - *440 - - &580 + - *441 + - &581 name: deployment_id description: deployment_id parameter in: path @@ -85536,7 +85595,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *579 examples: default: value: @@ -85601,9 +85660,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *439 - *440 - - *580 + - *441 + - *581 responses: '204': description: Response @@ -85625,9 +85684,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *439 - *440 - - *580 + - *441 + - *581 - *17 - *19 responses: @@ -85637,7 +85696,7 @@ paths: application/json: schema: type: array - items: &581 + items: &582 title: Deployment Status description: The status of a deployment. type: object @@ -85801,9 +85860,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *439 - *440 - - *580 + - *441 + - *581 requestBody: required: true content: @@ -85878,9 +85937,9 @@ paths: description: Response content: application/json: - schema: *581 + schema: *582 examples: - default: &582 + default: &583 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -85936,9 +85995,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *439 - *440 - - *580 + - *441 + - *581 - name: status_id in: path required: true @@ -85949,9 +86008,9 @@ paths: description: Response content: application/json: - schema: *581 + schema: *582 examples: - default: *582 + default: *583 '404': *6 x-github: githubCloudOnly: false @@ -85978,12 +86037,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 - - *583 + - *441 - *584 - *585 - *586 + - *587 - *17 - *19 responses: @@ -85993,9 +86052,9 @@ paths: application/json: schema: type: array - items: *587 + items: *588 examples: - default: *588 + default: *589 '404': *6 '403': *27 '500': *38 @@ -86019,8 +86078,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86032,7 +86091,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *587 + schema: *588 examples: default: value: @@ -86088,8 +86147,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86148,12 +86207,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *439 - *440 - - *583 + - *441 - *584 - *585 - *586 + - *587 - *17 - *19 responses: @@ -86163,9 +86222,9 @@ paths: application/json: schema: type: array - items: *589 + items: *590 examples: - default: *590 + default: *591 '404': *6 '403': *27 '500': *38 @@ -86189,8 +86248,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86202,7 +86261,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *589 + schema: *590 examples: default: value: @@ -86253,8 +86312,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86292,7 +86351,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *589 + schema: *590 examples: default: value: @@ -86343,8 +86402,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86415,8 +86474,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86449,8 +86508,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - *101 - *102 - *103 @@ -86464,9 +86523,9 @@ paths: application/json: schema: type: array - items: *591 + items: *592 examples: - default: *592 + default: *593 '404': *6 '403': *27 '500': *38 @@ -86491,8 +86550,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86504,7 +86563,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *591 + schema: *592 examples: default: value: @@ -86562,8 +86621,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *439 - *440 + - *441 - name: alert_number in: path required: true @@ -86632,8 +86691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -86690,8 +86749,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -86709,7 +86768,7 @@ paths: - 5 environments: type: array - items: &594 + items: &595 title: Environment description: Details of a deployment environment type: object @@ -86771,7 +86830,7 @@ paths: type: string examples: - wait_timer - wait_timer: &596 + wait_timer: &597 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -86813,7 +86872,7 @@ paths: items: type: object properties: - type: *593 + type: *594 reviewer: anyOf: - *4 @@ -86840,7 +86899,7 @@ paths: - id - node_id - type - deployment_branch_policy: &597 + deployment_branch_policy: &598 type: - object - 'null' @@ -86957,9 +87016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *439 - *440 - - &595 + - *441 + - &596 name: environment_name in: path required: true @@ -86972,9 +87031,9 @@ paths: description: Response content: application/json: - schema: *594 + schema: *595 examples: - default: &598 + default: &599 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -87058,9 +87117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *439 - *440 - - *595 + - *441 + - *596 requestBody: required: false content: @@ -87070,7 +87129,7 @@ paths: - object - 'null' properties: - wait_timer: *596 + wait_timer: *597 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -87089,14 +87148,14 @@ paths: items: type: object properties: - type: *593 + type: *594 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *597 + deployment_branch_policy: *598 additionalProperties: false examples: default: @@ -87116,9 +87175,9 @@ paths: description: Response content: application/json: - schema: *594 + schema: *595 examples: - default: *598 + default: *599 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -87142,9 +87201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *439 - *440 - - *595 + - *441 + - *596 responses: '204': description: Default response @@ -87169,9 +87228,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *17 - *19 responses: @@ -87190,7 +87249,7 @@ paths: - 2 branch_policies: type: array - items: &599 + items: &600 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -87251,9 +87310,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *439 - *440 - - *595 + - *441 + - *596 requestBody: required: true content: @@ -87301,9 +87360,9 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: - example-wildcard: &600 + example-wildcard: &601 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -87345,10 +87404,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *439 - *440 - - *595 - - &601 + - *441 + - *596 + - &602 name: branch_policy_id in: path required: true @@ -87360,9 +87419,9 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87381,10 +87440,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *439 - *440 - - *595 - - *601 + - *441 + - *596 + - *602 requestBody: required: true content: @@ -87413,9 +87472,9 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87434,10 +87493,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *439 - *440 - - *595 - - *601 + - *441 + - *596 + - *602 responses: '204': description: Response @@ -87462,9 +87521,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *595 + - *596 + - *441 - *440 - - *439 responses: '200': description: List of deployment protection rules @@ -87481,7 +87540,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &602 + items: &603 title: Deployment protection rule description: Deployment protection rule type: object @@ -87503,7 +87562,7 @@ paths: for the environment. examples: - true - app: &603 + app: &604 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -87606,9 +87665,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *595 + - *596 + - *441 - *440 - - *439 requestBody: content: application/json: @@ -87629,9 +87688,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *602 + schema: *603 examples: - default: &604 + default: &605 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -87666,9 +87725,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *595 + - *596 + - *441 - *440 - - *439 - *19 - *17 responses: @@ -87688,7 +87747,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *603 + items: *604 examples: default: value: @@ -87723,10 +87782,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *439 - *440 - - *595 - - &605 + - *441 + - *596 + - &606 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -87738,9 +87797,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *603 examples: - default: *604 + default: *605 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87761,10 +87820,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *595 + - *596 + - *441 - *440 - - *439 - - *605 + - *606 responses: '204': description: Response @@ -87790,9 +87849,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *17 - *19 responses: @@ -87810,9 +87869,9 @@ paths: type: integer secrets: type: array - items: *470 + items: *471 examples: - default: *471 + default: *472 headers: Link: *45 x-github: @@ -87837,17 +87896,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *439 - *440 - - *595 + - *441 + - *596 responses: '200': description: Response content: application/json: - schema: *472 + schema: *473 examples: - default: *473 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87869,18 +87928,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *283 responses: '200': description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *606 + default: *607 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87902,9 +87961,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *283 requestBody: required: true @@ -87962,9 +88021,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *283 responses: '204': @@ -87990,10 +88049,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *439 - *440 - - *595 - - *457 + - *441 + - *596 + - *458 - *19 responses: '200': @@ -88010,9 +88069,9 @@ paths: type: integer variables: type: array - items: *474 + items: *475 examples: - default: *475 + default: *476 headers: Link: *45 x-github: @@ -88035,9 +88094,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *439 - *440 - - *595 + - *441 + - *596 requestBody: required: true content: @@ -88089,18 +88148,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *439 - *440 - - *595 + - *441 + - *596 - *286 responses: '200': description: Response content: application/json: - schema: *474 + schema: *475 examples: - default: *607 + default: *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88121,10 +88180,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *439 - *440 + - *441 - *286 - - *595 + - *596 requestBody: required: true content: @@ -88166,10 +88225,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *439 - *440 + - *441 - *286 - - *595 + - *596 responses: '204': description: Response @@ -88191,8 +88250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -88260,8 +88319,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *439 - *440 + - *441 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -88420,8 +88479,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -88454,9 +88513,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *445 examples: - default: *446 + default: *447 '400': *14 '422': *15 '403': *27 @@ -88477,8 +88536,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -88538,7 +88597,7 @@ paths: schema: oneOf: - *248 - - *608 + - *609 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88563,8 +88622,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *439 - *440 + - *441 - name: file_sha in: path required: true @@ -88664,8 +88723,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -88774,7 +88833,7 @@ paths: description: Response content: application/json: - schema: &609 + schema: &610 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -89001,15 +89060,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *439 - *440 - - *554 + - *441 + - *555 responses: '200': description: Response content: application/json: - schema: *609 + schema: *610 examples: default: value: @@ -89065,9 +89124,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *439 - *440 - - &610 + - *441 + - &611 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -89084,7 +89143,7 @@ paths: application/json: schema: type: array - items: &611 + items: &612 title: Git Reference description: Git references within a repository type: object @@ -89160,17 +89219,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *439 - *440 - - *610 + - *441 + - *611 responses: '200': description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: &612 + default: &613 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -89199,8 +89258,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -89229,9 +89288,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *612 + default: *613 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -89257,9 +89316,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *439 - *440 - - *610 + - *441 + - *611 requestBody: required: true content: @@ -89288,9 +89347,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *612 + default: *613 '422': *15 '409': *117 x-github: @@ -89308,9 +89367,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *439 - *440 - - *610 + - *441 + - *611 responses: '204': description: Response @@ -89365,8 +89424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -89433,7 +89492,7 @@ paths: description: Response content: application/json: - schema: &614 + schema: &615 title: Git Tag description: Metadata for a Git tag type: object @@ -89489,7 +89548,7 @@ paths: - sha - type - url - verification: *613 + verification: *614 required: - sha - url @@ -89499,7 +89558,7 @@ paths: - tag - message examples: - default: &615 + default: &616 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -89572,8 +89631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *439 - *440 + - *441 - name: tag_sha in: path required: true @@ -89584,9 +89643,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: *615 + default: *616 '404': *6 '409': *117 x-github: @@ -89610,8 +89669,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -89685,7 +89744,7 @@ paths: description: Response content: application/json: - schema: &616 + schema: &617 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -89787,8 +89846,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *439 - *440 + - *441 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -89811,7 +89870,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *617 examples: default-response: summary: Default response @@ -89870,8 +89929,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -89881,7 +89940,7 @@ paths: application/json: schema: type: array - items: &617 + items: &618 title: Webhook description: Webhooks for repositories. type: object @@ -90021,8 +90080,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -90075,9 +90134,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *618 examples: - default: &618 + default: &619 value: type: Repository id: 12345678 @@ -90125,17 +90184,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 responses: '200': description: Response content: application/json: - schema: *617 + schema: *618 examples: - default: *618 + default: *619 '404': *6 x-github: githubCloudOnly: false @@ -90155,8 +90214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 requestBody: required: true @@ -90202,9 +90261,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *618 examples: - default: *618 + default: *619 '422': *15 '404': *6 x-github: @@ -90225,8 +90284,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 responses: '204': @@ -90251,8 +90310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *439 - *440 + - *441 - *335 responses: '200': @@ -90280,8 +90339,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *439 - *440 + - *441 - *335 requestBody: required: false @@ -90326,8 +90385,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 - *17 - *336 @@ -90359,8 +90418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 - *16 responses: @@ -90389,8 +90448,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 - *16 responses: @@ -90414,8 +90473,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *439 - *440 + - *441 - *335 responses: '204': @@ -90441,8 +90500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *439 - *440 + - *441 - *335 responses: '204': @@ -90466,8 +90525,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response if immutable releases are enabled @@ -90515,8 +90574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *439 - *440 + - *441 responses: '204': *149 '409': *117 @@ -90536,8 +90595,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *439 - *440 + - *441 responses: '204': *149 '409': *117 @@ -90594,14 +90653,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *439 - *440 + - *441 responses: '200': description: Response content: application/json: - schema: &619 + schema: &620 title: Import description: A repository import from an external source. type: object @@ -90708,7 +90767,7 @@ paths: - html_url - authors_url examples: - default: &622 + default: &623 value: vcs: subversion use_lfs: true @@ -90724,7 +90783,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &620 + '503': &621 description: Unavailable due to service under maintenance. content: application/json: @@ -90753,8 +90812,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -90802,7 +90861,7 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: default: value: @@ -90827,7 +90886,7 @@ paths: type: string '422': *15 '404': *6 - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90855,8 +90914,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -90908,7 +90967,7 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: example-1: summary: Example 1 @@ -90956,7 +91015,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90979,12 +91038,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *439 - *440 + - *441 responses: '204': description: Response - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91010,8 +91069,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *439 - *440 + - *441 - &800 name: since description: A user ID. Only return users with an ID greater than this ID. @@ -91026,7 +91085,7 @@ paths: application/json: schema: type: array - items: &621 + items: &622 title: Porter Author description: Porter Author type: object @@ -91080,7 +91139,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91105,8 +91164,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *439 - *440 + - *441 - name: author_id in: path required: true @@ -91136,7 +91195,7 @@ paths: description: Response content: application/json: - schema: *621 + schema: *622 examples: default: value: @@ -91149,7 +91208,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91173,8 +91232,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -91215,7 +91274,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91243,8 +91302,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -91271,11 +91330,11 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: - default: *622 + default: *623 '422': *15 - '503': *620 + '503': *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91298,8 +91357,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -91307,8 +91366,8 @@ paths: application/json: schema: *20 examples: - default: *623 - '301': *445 + default: *352 + '301': *446 '404': *6 x-github: githubCloudOnly: false @@ -91328,8 +91387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -91337,7 +91396,7 @@ paths: application/json: schema: anyOf: - - *353 + - *354 - type: object properties: {} additionalProperties: false @@ -91367,8 +91426,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -91385,7 +91444,7 @@ paths: description: Response content: application/json: - schema: *353 + schema: *354 examples: default: *625 '409': @@ -91409,8 +91468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -91433,8 +91492,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -91577,9 +91636,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *439 - *440 - - *357 + - *441 + - *358 requestBody: required: false content: @@ -91739,9 +91798,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *439 - *440 - - *357 + - *441 + - *358 responses: '204': description: Response @@ -91772,8 +91831,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *439 - *440 + - *441 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -91821,7 +91880,7 @@ paths: required: false schema: type: string - - *361 + - *362 - name: sort description: What to sort results by. in: query @@ -91994,7 +92053,7 @@ paths: state_reason: completed headers: Link: *45 - '301': *445 + '301': *446 '422': *15 '404': *6 x-github: @@ -92023,8 +92082,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -92300,8 +92359,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *439 - *440 + - *441 - *236 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -92382,8 +92441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *439 - *440 + - *441 - *228 responses: '200': @@ -92446,8 +92505,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -92490,8 +92549,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *439 - *440 + - *441 - *228 responses: '204': @@ -92512,8 +92571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *439 - *440 + - *441 - *228 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -92540,7 +92599,7 @@ paths: application/json: schema: type: array - items: *551 + items: *552 examples: default: *630 headers: @@ -92563,8 +92622,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -92597,16 +92656,16 @@ paths: description: Reaction exists content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '201': description: Reaction created content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '422': *15 x-github: githubCloudOnly: false @@ -92628,8 +92687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *439 - *440 + - *441 - *228 - *631 responses: @@ -92651,8 +92710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -93001,8 +93060,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *439 - *440 + - *441 - name: event_id in: path required: true @@ -93239,8 +93298,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *439 - *440 + - *441 - &634 name: issue_number description: The number that identifies the issue. @@ -93256,7 +93315,7 @@ paths: schema: *213 examples: default: *633 - '301': *445 + '301': *446 '404': *6 '410': *627 '304': *35 @@ -93283,8 +93342,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: false @@ -93410,7 +93469,7 @@ paths: '422': *15 '503': *190 '403': *27 - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -93430,8 +93489,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: false @@ -93476,8 +93535,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: content: @@ -93527,8 +93586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *439 - *440 + - *441 - *634 - name: assignee in: path @@ -93569,8 +93628,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *439 - *440 + - *441 - *634 - *219 - *17 @@ -93617,8 +93676,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -93678,8 +93737,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -93695,7 +93754,7 @@ paths: default: *636 headers: Link: *45 - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -93725,8 +93784,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -93757,7 +93816,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *445 + '301': *446 '403': *27 '410': *627 '422': *15 @@ -93790,8 +93849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *439 - *440 + - *441 - *634 - name: issue_id in: path @@ -93807,7 +93866,7 @@ paths: schema: *213 examples: default: *633 - '301': *445 + '301': *446 '400': *14 '401': *23 '403': *27 @@ -93838,8 +93897,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -93855,7 +93914,7 @@ paths: default: *636 headers: Link: *45 - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -93874,8 +93933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -94686,8 +94745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -94718,7 +94777,7 @@ paths: default: false headers: Link: *45 - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -94737,8 +94796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: false @@ -94801,7 +94860,7 @@ paths: items: *212 examples: default: *637 - '301': *445 + '301': *446 '404': *6 '410': *627 '422': *15 @@ -94820,8 +94879,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: false @@ -94885,7 +94944,7 @@ paths: items: *212 examples: default: *637 - '301': *445 + '301': *446 '404': *6 '410': *627 '422': *15 @@ -94904,13 +94963,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *439 - *440 + - *441 - *634 responses: '204': description: Response - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -94931,8 +94990,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *439 - *440 + - *441 - *634 - name: name in: path @@ -94957,7 +95016,7 @@ paths: description: Something isn't working color: f29513 default: true - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -94979,8 +95038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: false @@ -95028,8 +95087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *439 - *440 + - *441 - *634 responses: '204': @@ -95060,8 +95119,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *439 - *440 + - *441 - *634 responses: '200': @@ -95071,7 +95130,7 @@ paths: schema: *213 examples: default: *633 - '301': *445 + '301': *446 '404': *6 '410': *627 x-github: @@ -95090,8 +95149,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *439 - *440 + - *441 - *634 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -95118,7 +95177,7 @@ paths: application/json: schema: type: array - items: *551 + items: *552 examples: default: *630 headers: @@ -95142,8 +95201,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -95176,16 +95235,16 @@ paths: description: Response content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '201': description: Response content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '422': *15 x-github: githubCloudOnly: false @@ -95207,8 +95266,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *439 - *440 + - *441 - *634 - *631 responses: @@ -95239,8 +95298,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -95298,8 +95357,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -95344,8 +95403,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -95402,8 +95461,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *439 - *440 + - *441 - *634 requestBody: required: true @@ -95459,8 +95518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *439 - *440 + - *441 - *634 - *17 - *19 @@ -95542,6 +95601,9 @@ paths: - type: 'null' - *5 reactions: *215 + pin: + anyOf: + - type: 'null' required: - event - actor @@ -96058,7 +96120,7 @@ paths: type: string comments: type: array - items: *550 + items: *551 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -96350,8 +96412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -96429,8 +96491,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -96502,8 +96564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *439 - *440 + - *441 - &653 name: key_id description: The unique identifier of the key. @@ -96536,8 +96598,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *439 - *440 + - *441 - *653 responses: '204': @@ -96558,8 +96620,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -96592,8 +96654,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -96663,8 +96725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *439 - *440 + - *441 - name: name in: path required: true @@ -96694,8 +96756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *439 - *440 + - *441 - name: name in: path required: true @@ -96760,8 +96822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *439 - *440 + - *441 - name: name in: path required: true @@ -96787,8 +96849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -96824,8 +96886,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *439 - *440 + - *441 responses: '202': *37 '403': @@ -96853,8 +96915,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -96880,9 +96942,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *439 - *440 - - *525 + - *441 + - *526 responses: '200': description: Response @@ -97029,8 +97091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -97095,8 +97157,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -97130,7 +97192,7 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *553 + schema: *554 examples: default: *655 '204': @@ -97157,8 +97219,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *439 - *440 + - *441 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -97199,7 +97261,7 @@ paths: application/json: schema: type: array - items: *392 + items: *393 examples: default: value: @@ -97255,8 +97317,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -97296,7 +97358,7 @@ paths: description: Response content: application/json: - schema: *392 + schema: *393 examples: default: &656 value: @@ -97357,8 +97419,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *439 - *440 + - *441 - &657 name: milestone_number description: The number that identifies the milestone. @@ -97371,7 +97433,7 @@ paths: description: Response content: application/json: - schema: *392 + schema: *393 examples: default: *656 '404': *6 @@ -97390,8 +97452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *439 - *440 + - *441 - *657 requestBody: required: false @@ -97430,7 +97492,7 @@ paths: description: Response content: application/json: - schema: *392 + schema: *393 examples: default: *656 x-github: @@ -97448,8 +97510,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *439 - *440 + - *441 - *657 responses: '204': @@ -97471,8 +97533,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *439 - *440 + - *441 - *657 - *17 - *19 @@ -97504,8 +97566,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *439 - *440 + - *441 - *658 - *659 - *219 @@ -97545,8 +97607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -97604,8 +97666,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -97796,8 +97858,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -97877,8 +97939,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -97986,8 +98048,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -98013,8 +98075,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -98116,8 +98178,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *439 - *440 + - *441 responses: '201': description: Response @@ -98164,8 +98226,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -98221,8 +98283,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *439 - *440 + - *441 - name: build_id in: path required: true @@ -98255,8 +98317,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -98364,8 +98426,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *439 - *440 + - *441 - &666 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit @@ -98424,8 +98486,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *439 - *440 + - *441 - *666 responses: '204': *149 @@ -98453,8 +98515,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -98749,8 +98811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Private vulnerability reporting status @@ -98787,8 +98849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': *149 '422': *14 @@ -98809,8 +98871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': *149 '422': *14 @@ -98832,8 +98894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -98865,8 +98927,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -98920,8 +98982,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *439 - *440 + - *441 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -98981,7 +99043,7 @@ paths: application/json: schema: type: array - items: *557 + items: *558 examples: default: *669 headers: @@ -99015,8 +99077,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -99212,7 +99274,7 @@ paths: milestone: anyOf: - type: 'null' - - *392 + - *393 active_lock_reason: type: - string @@ -99267,7 +99329,7 @@ paths: type: - array - 'null' - items: *371 + items: *372 head: type: object properties: @@ -99305,14 +99367,14 @@ paths: _links: type: object properties: - comments: *393 - commits: *393 - statuses: *393 - html: *393 - issue: *393 - review_comments: *393 - review_comment: *393 - self: *393 + comments: *394 + commits: *394 + statuses: *394 + html: *394 + issue: *394 + review_comments: *394 + review_comment: *394 + self: *394 required: - comments - commits @@ -99952,8 +100014,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *439 - *440 + - *441 - name: sort in: query required: false @@ -100061,8 +100123,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *439 - *440 + - *441 - *228 responses: '200': @@ -100146,8 +100208,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -100188,8 +100250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *439 - *440 + - *441 - *228 responses: '204': @@ -100211,8 +100273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *439 - *440 + - *441 - *228 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -100239,7 +100301,7 @@ paths: application/json: schema: type: array - items: *551 + items: *552 examples: default: *630 headers: @@ -100262,8 +100324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *439 - *440 + - *441 - *228 requestBody: required: true @@ -100296,16 +100358,16 @@ paths: description: Reaction exists content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '201': description: Reaction created content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '422': *15 x-github: githubCloudOnly: false @@ -100327,8 +100389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *439 - *440 + - *441 - *228 - *631 responses: @@ -100373,8 +100435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *439 - *440 + - *441 - &675 name: pull_number description: The number that identifies the pull request. @@ -100425,8 +100487,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: false @@ -100493,8 +100555,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: true @@ -100556,17 +100618,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '401': *23 '403': *27 '404': *6 @@ -100596,8 +100658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *236 - name: direction @@ -100654,8 +100716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: true @@ -100850,8 +100912,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *439 - *440 + - *441 - *675 - *228 requestBody: @@ -100961,8 +101023,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *17 - *19 @@ -100973,7 +101035,7 @@ paths: application/json: schema: type: array - items: *553 + items: *554 examples: default: *677 headers: @@ -101005,8 +101067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *439 - *440 + - *441 - *675 - *17 - *19 @@ -101017,7 +101079,7 @@ paths: application/json: schema: type: array - items: *564 + items: *565 examples: default: value: @@ -101055,8 +101117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *439 - *440 + - *441 - *675 responses: '204': @@ -101080,8 +101142,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: false @@ -101194,8 +101256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 responses: '200': @@ -101271,8 +101333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: false @@ -101310,7 +101372,7 @@ paths: description: Response content: application/json: - schema: *557 + schema: *558 examples: default: value: @@ -101846,8 +101908,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: true @@ -101882,7 +101944,7 @@ paths: description: Response content: application/json: - schema: *557 + schema: *558 examples: default: value: @@ -102387,8 +102449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *17 - *19 @@ -102555,8 +102617,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 requestBody: required: false @@ -102712,8 +102774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - &679 name: review_id @@ -102788,8 +102850,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *679 requestBody: @@ -102876,8 +102938,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *679 responses: @@ -102914,8 +102976,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *439 - *440 + - *441 - *675 - *679 - *17 @@ -103015,9 +103077,9 @@ paths: _links: type: object properties: - self: *393 - html: *393 - pull_request: *393 + self: *394 + html: *394 + pull_request: *394 required: - self - html @@ -103175,8 +103237,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *679 requestBody: @@ -103270,8 +103332,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *439 - *440 + - *441 - *675 - *679 requestBody: @@ -103332,8 +103394,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *439 - *440 + - *441 - *675 requestBody: required: false @@ -103398,8 +103460,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *439 - *440 + - *441 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -103456,8 +103518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *439 - *440 + - *441 - name: dir description: The alternate path to look for a README file in: path @@ -103501,8 +103563,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -103606,8 +103668,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -103790,8 +103852,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *439 - *440 + - *441 - &686 name: asset_id description: The unique identifier of the asset. @@ -103841,7 +103903,7 @@ paths: type: User site_admin: false '404': *6 - '302': *566 + '302': *567 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103857,8 +103919,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *439 - *440 + - *441 - *686 requestBody: required: false @@ -103906,8 +103968,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *439 - *440 + - *441 - *686 responses: '204': @@ -103932,8 +103994,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -104019,8 +104081,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -104045,8 +104107,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *439 - *440 + - *441 - name: tag description: tag parameter in: path @@ -104083,8 +104145,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *439 - *440 + - *441 - &689 name: release_id description: The unique identifier of the release. @@ -104119,8 +104181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *439 - *440 + - *441 - *689 requestBody: required: false @@ -104208,8 +104270,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *439 - *440 + - *441 - *689 responses: '204': @@ -104230,8 +104292,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *439 - *440 + - *441 - *689 - *17 - *19 @@ -104324,8 +104386,8 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *439 - *440 + - *441 - *689 - name: name in: query @@ -104407,8 +104469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *439 - *440 + - *441 - *689 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -104433,7 +104495,7 @@ paths: application/json: schema: type: array - items: *551 + items: *552 examples: default: *630 headers: @@ -104456,8 +104518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *439 - *440 + - *441 - *689 requestBody: required: true @@ -104488,16 +104550,16 @@ paths: description: Reaction exists content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '201': description: Reaction created content: application/json: - schema: *551 + schema: *552 examples: - default: *552 + default: *553 '422': *15 x-github: githubCloudOnly: false @@ -104519,8 +104581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *439 - *440 + - *441 - *689 - *631 responses: @@ -104546,9 +104608,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *439 - *440 - - *492 + - *441 + - *493 - *17 - *19 responses: @@ -104685,8 +104747,8 @@ paths: category: repos subcategory: rules parameters: - - *439 - *440 + - *441 - *17 - *19 - name: includes_parents @@ -104752,8 +104814,8 @@ paths: category: repos subcategory: rules parameters: - - *439 - *440 + - *441 requestBody: description: Request body required: true @@ -104862,8 +104924,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *439 - *440 + - *441 - *694 - *103 - *695 @@ -104898,8 +104960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *439 - *440 + - *441 - *699 responses: '200': @@ -104936,8 +104998,8 @@ paths: category: repos subcategory: rules parameters: - - *439 - *440 + - *441 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104977,8 +105039,8 @@ paths: category: repos subcategory: rules parameters: - - *439 - *440 + - *441 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105060,8 +105122,8 @@ paths: category: repos subcategory: rules parameters: - - *439 - *440 + - *441 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105084,8 +105146,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *439 - *440 + - *441 - *17 - *19 - name: ruleset_id @@ -105103,7 +105165,7 @@ paths: type: array items: *189 examples: - default: *409 + default: *410 '404': *6 '500': *38 x-github: @@ -105122,8 +105184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *439 - *440 + - *441 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105141,15 +105203,15 @@ paths: description: Response content: application/json: - schema: *410 + schema: *411 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 @@ -105196,22 +105258,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *439 - *440 - - *411 + - *441 - *412 - *413 - *414 - *415 + - *416 - *108 - *19 - *17 - *703 - *704 - - *416 - *417 - *418 - *419 + - *420 responses: '200': description: Response @@ -105475,10 +105537,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *439 - *440 - - *519 - - *419 + - *441 + - *520 + - *420 responses: '200': description: Response @@ -105538,9 +105600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 requestBody: required: true content: @@ -105680,9 +105742,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *439 - *440 - - *519 + - *441 + - *520 - *19 - *17 responses: @@ -105818,8 +105880,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -105898,8 +105960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *439 - *440 + - *441 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -106020,8 +106082,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *439 - *440 + - *441 - *108 - name: sort description: The property to sort the results by. @@ -106090,8 +106152,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -106171,7 +106233,7 @@ paths: login: type: string description: The username of the user credited. - type: *424 + type: *425 required: - login - type @@ -106496,8 +106558,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -106757,8 +106819,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *439 - *440 + - *441 - *727 responses: '200': @@ -106791,8 +106853,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *439 - *440 + - *441 - *727 requestBody: required: true @@ -106873,7 +106935,7 @@ paths: login: type: string description: The username of the user credited. - type: *424 + type: *425 required: - login - type @@ -107005,8 +107067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *439 - *440 + - *441 - *727 responses: '202': *37 @@ -107034,17 +107096,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *439 - *440 + - *441 - *727 responses: '202': description: Response content: application/json: - schema: *444 + schema: *445 examples: - default: *446 + default: *447 '400': *14 '422': *15 '403': *27 @@ -107070,8 +107132,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -107167,8 +107229,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *439 - *440 + - *441 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -107210,8 +107272,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -107289,8 +107351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -107384,8 +107446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *439 - *440 + - *441 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -107539,8 +107601,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *439 - *440 + - *441 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -107583,8 +107645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *439 - *440 + - *441 - name: sha in: path required: true @@ -107694,8 +107756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -107727,8 +107789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *439 - *440 + - *441 responses: '200': description: if you subscribe to the repository @@ -107807,8 +107869,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *439 - *440 + - *441 requestBody: required: false content: @@ -107861,8 +107923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -107882,8 +107944,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -107965,8 +108027,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -108031,8 +108093,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -108086,8 +108148,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *439 - *440 + - *441 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -108124,8 +108186,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *439 - *440 + - *441 - name: ref in: path required: true @@ -108161,8 +108223,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *439 - *440 + - *441 - *17 - *19 responses: @@ -108174,7 +108236,7 @@ paths: type: array items: *302 examples: - default: *372 + default: *373 headers: Link: *45 '404': *6 @@ -108194,8 +108256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *439 - *440 + - *441 - *19 - *17 responses: @@ -108238,8 +108300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -108293,8 +108355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *439 - *440 + - *441 - &735 name: per description: The time frame to display results for. @@ -108413,8 +108475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -108508,8 +108570,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *439 - *440 + - *441 responses: '200': description: Response @@ -108572,8 +108634,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *439 - *440 + - *441 - *735 responses: '200': @@ -108672,8 +108734,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *439 - *440 + - *441 requestBody: required: true content: @@ -108947,8 +109009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *439 - *440 + - *441 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -108971,8 +109033,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -108994,8 +109056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -109021,8 +109083,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *439 - *440 + - *441 - name: ref in: path required: true @@ -109114,9 +109176,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *445 examples: - default: *446 + default: *447 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -111668,7 +111730,7 @@ paths: committer: anyOf: - type: 'null' - - *490 + - *491 comment_count: type: integer message: @@ -111687,7 +111749,7 @@ paths: url: type: string format: uri - verification: *613 + verification: *614 required: - author - committer @@ -111702,7 +111764,7 @@ paths: committer: anyOf: - type: 'null' - - *490 + - *491 parents: type: array items: @@ -112027,7 +112089,7 @@ paths: milestone: anyOf: - type: 'null' - - *392 + - *393 comments: type: integer created_at: @@ -112090,7 +112152,7 @@ paths: timeline_url: type: string format: uri - type: *358 + type: *359 performed_via_github_app: anyOf: - type: 'null' @@ -113340,9 +113402,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '404': *6 x-github: githubCloudOnly: false @@ -113433,16 +113495,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '201': description: Response content: application/json: - schema: *432 + schema: *433 examples: - default: *433 + default: *434 '404': *6 '422': *15 '403': *27 @@ -113509,9 +113571,9 @@ paths: application/json: schema: type: array - items: *355 + items: *356 examples: - default: *356 + default: *357 headers: Link: *45 x-github: @@ -113709,7 +113771,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *439 examples: response-if-user-is-a-team-maintainer: *769 '404': *6 @@ -113770,7 +113832,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *439 examples: response-if-users-membership-with-team-is-now-pending: *770 '403': @@ -113846,7 +113908,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 '404': *6 @@ -113877,8 +113939,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - *768 - - *439 - *440 + - *441 responses: '200': description: Alternative response with extra repository information @@ -114036,8 +114098,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - *768 - - *439 - *440 + - *441 requestBody: required: false content: @@ -114088,8 +114150,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - *768 - - *439 - *440 + - *441 responses: '204': description: Response @@ -114124,9 +114186,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *442 examples: - default: *442 + default: *443 '403': *27 '404': *6 x-github: @@ -114214,7 +114276,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *442 examples: default: value: @@ -114903,9 +114965,9 @@ paths: type: integer codespaces: type: array - items: *363 + items: *364 examples: - default: *364 + default: *365 '304': *35 '500': *38 '401': *23 @@ -115044,17 +115106,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '401': *23 '403': *27 '404': *6 @@ -115140,7 +115202,7 @@ paths: - visibility - selected_repositories_url examples: - default: *544 + default: *545 headers: Link: *45 x-github: @@ -115508,15 +115570,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 responses: '200': description: Response content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '304': *35 '500': *38 '401': *23 @@ -115542,7 +115604,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 requestBody: required: false content: @@ -115572,9 +115634,9 @@ paths: description: Response content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '401': *23 '403': *27 '404': *6 @@ -115596,7 +115658,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 responses: '202': *37 '304': *35 @@ -115625,7 +115687,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 responses: '202': description: Response @@ -115716,7 +115778,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *365 + - *366 - name: export_id in: path required: true @@ -115752,7 +115814,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *365 + - *366 responses: '200': description: Response @@ -115768,7 +115830,7 @@ paths: type: integer machines: type: array - items: *543 + items: *544 examples: default: *779 '304': *35 @@ -115799,7 +115861,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *365 + - *366 requestBody: required: true content: @@ -115855,11 +115917,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *444 + repository: *445 machine: anyOf: - type: 'null' - - *543 + - *544 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -116656,15 +116718,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 responses: '200': description: Response content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '304': *35 '500': *38 '400': *14 @@ -116696,15 +116758,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *365 + - *366 responses: '200': description: Response content: application/json: - schema: *363 + schema: *364 examples: - default: *542 + default: *543 '500': *38 '401': *23 '403': *27 @@ -116734,7 +116796,7 @@ paths: application/json: schema: type: array - items: *373 + items: *374 examples: default: &790 value: @@ -117848,12 +117910,12 @@ paths: application/json: schema: anyOf: - - *353 + - *354 - type: object properties: {} additionalProperties: false examples: - default: *354 + default: *355 '204': description: Response when there are no restrictions x-github: @@ -117888,7 +117950,7 @@ paths: description: Response content: application/json: - schema: *353 + schema: *354 examples: default: value: @@ -117969,7 +118031,7 @@ paths: - closed - all default: open - - *361 + - *362 - name: sort description: What to sort results by. in: query @@ -117994,7 +118056,7 @@ paths: type: array items: *213 examples: - default: *362 + default: *363 headers: Link: *45 '404': *6 @@ -118412,7 +118474,7 @@ paths: application/json: schema: type: array - items: *366 + items: *367 examples: default: value: @@ -118526,7 +118588,7 @@ paths: description: Response content: application/json: - schema: *366 + schema: *367 examples: default: value: @@ -118613,7 +118675,7 @@ paths: description: Response content: application/json: - schema: *366 + schema: *367 examples: default: value: @@ -118685,7 +118747,7 @@ paths: application/json: schema: type: array - items: *368 + items: *369 examples: default: value: @@ -118947,7 +119009,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *369 examples: default: value: @@ -119127,7 +119189,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *369 + - *370 - name: exclude in: query required: false @@ -119140,7 +119202,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *369 examples: default: value: @@ -119334,7 +119396,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *369 + - *370 responses: '302': description: Response @@ -119360,7 +119422,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *369 + - *370 responses: '204': description: Response @@ -119389,7 +119451,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *369 + - *370 - *788 responses: '204': @@ -119414,7 +119476,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *369 + - *370 - *17 - *19 responses: @@ -119426,7 +119488,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 '404': *6 @@ -119515,7 +119577,7 @@ paths: application/json: schema: type: array - items: *373 + items: *374 examples: default: *790 '400': *791 @@ -119538,14 +119600,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *375 - *376 + - *377 responses: '200': description: Response content: application/json: - schema: *373 + schema: *374 examples: default: &809 value: @@ -119660,8 +119722,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *375 - *376 + - *377 responses: '204': description: Response @@ -119691,8 +119753,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *375 - *376 + - *377 - name: token description: package token schema: @@ -119724,8 +119786,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *375 - *376 + - *377 - *19 - *17 - name: state @@ -119745,7 +119807,7 @@ paths: application/json: schema: type: array - items: *377 + items: *378 examples: default: value: @@ -119794,15 +119856,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *375 - *376 - - *378 + - *377 + - *379 responses: '200': description: Response content: application/json: - schema: *377 + schema: *378 examples: default: value: @@ -119838,9 +119900,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *375 - *376 - - *378 + - *377 + - *379 responses: '204': description: Response @@ -119870,9 +119932,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *375 - *376 - - *378 + - *377 + - *379 responses: '204': description: Response @@ -120342,9 +120404,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *445 examples: - default: *446 + default: *447 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -120407,7 +120469,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *357 + - *358 responses: '204': description: Response @@ -120430,7 +120492,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *357 + - *358 responses: '204': description: Response @@ -121001,8 +121063,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *439 - *440 + - *441 responses: '204': description: Response if this repository is starred by you @@ -121030,8 +121092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -121055,8 +121117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *439 - *440 + - *441 responses: '204': description: Response @@ -121091,7 +121153,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 '304': *35 @@ -121128,7 +121190,7 @@ paths: application/json: schema: type: array - items: *432 + items: *433 examples: default: value: @@ -121316,7 +121378,7 @@ paths: required: true schema: type: string - - *391 + - *392 requestBody: required: true description: Details of the draft item to create in the project. @@ -121350,9 +121412,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *397 examples: - draft_issue: *397 + draft_issue: *398 '304': *35 '403': *27 '401': *23 @@ -121411,7 +121473,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-a-user-owned-project parameters: - *801 - - *391 + - *392 requestBody: required: true content: @@ -121489,13 +121551,13 @@ paths: examples: table_view: summary: Response for creating a table view - value: *401 + value: *402 board_view: summary: Response for creating a board view with filter - value: *401 + value: *402 roadmap_view: summary: Response for creating a roadmap view - value: *401 + value: *402 '304': *35 '403': *27 '401': *23 @@ -121851,7 +121913,7 @@ paths: initiator: type: string examples: - default: *486 + default: *487 '201': description: Response content: @@ -121890,7 +121952,7 @@ paths: application/json: schema: type: array - items: *373 + items: *374 examples: default: *790 '403': *27 @@ -122382,7 +122444,7 @@ paths: application/json: schema: *20 examples: - default: *623 + default: *352 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122518,7 +122580,7 @@ paths: application/json: schema: type: array - items: *373 + items: *374 examples: default: *790 '403': *27 @@ -122543,15 +122605,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *375 - *376 + - *377 - *137 responses: '200': description: Response content: application/json: - schema: *373 + schema: *374 examples: default: *809 x-github: @@ -122574,8 +122636,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *375 - *376 + - *377 - *137 responses: '204': @@ -122608,8 +122670,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *375 - *376 + - *377 - *137 - name: token description: package token @@ -122642,8 +122704,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *375 - *376 + - *377 - *137 responses: '200': @@ -122652,7 +122714,7 @@ paths: application/json: schema: type: array - items: *377 + items: *378 examples: default: value: @@ -122710,16 +122772,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user parameters: - - *375 - *376 - - *378 + - *377 + - *379 - *137 responses: '200': description: Response content: application/json: - schema: *377 + schema: *378 examples: default: value: @@ -122754,10 +122816,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *375 - *376 + - *377 - *137 - - *378 + - *379 responses: '204': description: Response @@ -122789,10 +122851,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *375 - *376 + - *377 - *137 - - *378 + - *379 responses: '204': description: Response @@ -122833,9 +122895,9 @@ paths: application/json: schema: type: array - items: *389 + items: *390 examples: - default: *390 + default: *391 headers: Link: *45 '304': *35 @@ -122857,16 +122919,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *391 + - *392 - *137 responses: '200': description: Response content: application/json: - schema: *389 + schema: *390 examples: - default: *390 + default: *391 headers: Link: *45 '304': *35 @@ -122888,7 +122950,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *391 + - *392 - *137 - *17 - *106 @@ -122900,7 +122962,7 @@ paths: application/json: schema: type: array - items: *394 + items: *395 examples: default: *810 headers: @@ -122924,7 +122986,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project parameters: - *137 - - *391 + - *392 requestBody: required: true content: @@ -123007,7 +123069,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *395 examples: text_field: *815 number_field: *816 @@ -123034,7 +123096,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *391 + - *392 - *820 - *137 responses: @@ -123042,7 +123104,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *395 examples: default: *821 headers: @@ -123067,7 +123129,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project parameters: - - *391 + - *392 - *137 - *106 - *107 @@ -123100,9 +123162,9 @@ paths: application/json: schema: type: array - items: *398 + items: *399 examples: - default: *399 + default: *400 headers: Link: *45 '304': *35 @@ -123124,7 +123186,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - *137 - - *391 + - *392 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -123194,22 +123256,22 @@ paths: description: Response content: application/json: - schema: *396 + schema: *397 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *397 + value: *398 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *397 + value: *398 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *397 + value: *398 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *397 + value: *398 '304': *35 '403': *27 '401': *23 @@ -123229,9 +123291,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *391 + - *392 - *137 - - *400 + - *401 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -123251,9 +123313,9 @@ paths: description: Response content: application/json: - schema: *398 + schema: *399 examples: - default: *399 + default: *400 headers: Link: *45 '304': *35 @@ -123274,9 +123336,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *391 + - *392 - *137 - - *400 + - *401 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -123349,13 +123411,13 @@ paths: description: Response content: application/json: - schema: *398 + schema: *399 examples: - text_field: *399 - number_field: *399 - date_field: *399 - single_select_field: *399 - iteration_field: *399 + text_field: *400 + number_field: *400 + date_field: *400 + single_select_field: *400 + iteration_field: *400 '401': *23 '403': *27 '404': *6 @@ -123375,9 +123437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *391 + - *392 - *137 - - *400 + - *401 responses: '204': description: Response @@ -123399,7 +123461,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-project-view parameters: - - *391 + - *392 - *137 - *822 - name: fields @@ -123427,9 +123489,9 @@ paths: application/json: schema: type: array - items: *398 + items: *399 examples: - default: *399 + default: *400 headers: Link: *45 '304': *35 @@ -123650,7 +123712,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -123786,7 +123848,7 @@ paths: type: array items: *273 examples: - default: *379 + default: *380 headers: Link: *45 x-github: @@ -126642,7 +126704,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -126693,7 +126754,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -127039,7 +127099,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -127090,7 +127149,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -127436,7 +127494,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -127487,7 +127544,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -127848,7 +127904,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -127899,7 +127954,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -128471,11 +128525,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129185,11 +129234,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129892,11 +129936,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130315,7 +130354,7 @@ webhooks: required: - login - id - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -130647,7 +130686,7 @@ webhooks: required: - login - id - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -130991,7 +131030,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131350,7 +131389,7 @@ webhooks: required: - login - id - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -131633,7 +131672,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131931,7 +131970,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -132252,7 +132291,7 @@ webhooks: required: - login - id - dismissed_comment: *514 + dismissed_comment: *515 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -133364,7 +133403,7 @@ webhooks: type: string enum: - auto_dismissed - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133452,7 +133491,7 @@ webhooks: type: string enum: - auto_reopened - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133540,7 +133579,7 @@ webhooks: type: string enum: - created - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133626,7 +133665,7 @@ webhooks: type: string enum: - dismissed - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133712,7 +133751,7 @@ webhooks: type: string enum: - fixed - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133799,7 +133838,7 @@ webhooks: type: string enum: - reintroduced - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -133885,7 +133924,7 @@ webhooks: type: string enum: - reopened - alert: *572 + alert: *573 installation: *827 organization: *828 enterprise: *826 @@ -134590,11 +134629,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135403,7 +135437,7 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *578 + deployment: *579 pull_requests: type: array items: *673 @@ -138475,502 +138509,492 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - deployment_status: - description: The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses). - type: object - properties: - created_at: - type: string - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - deployment_url: - type: string - format: uri - description: - description: The optional human-readable description added to - the status. - type: string - environment: - type: string - environment_url: - type: string - format: uri - id: - type: integer - log_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - merge_queue_entry - - workflow_job - - merge_group - - secret_scanning_alert_location - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + production_environment: + type: boolean + ref: + type: string + repository_url: + type: string + format: uri + sha: + type: string + statuses_url: + type: string + format: uri + task: + type: string + transient_environment: + type: boolean + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - id + - node_id + - sha + - ref + - task + - payload + - original_environment + - environment + - description + - creator + - created_at + - updated_at + - statuses_url + - repository_url + deployment_status: + description: The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + deployment_url: + type: string + format: uri + description: + description: The optional human-readable description added to + the status. + type: string + environment: + type: string + environment_url: + type: string + format: uri + id: + type: integer + log_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps are + first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - pull_request_review_thread + - merge_queue_entry + - workflow_job + - merge_group + - secret_scanning_alert_location + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -144575,6 +144599,9 @@ webhooks: description: URL for the issue comment type: string format: uri + pin: + anyOf: + - type: 'null' user: title: User type: @@ -145386,7 +145413,2694 @@ webhooks: enum: - read - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: *765 + issue_dependencies_summary: *766 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *359 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - labels + - state + - locked + - assignee + organization: *828 + repository: *829 + 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-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: &857 + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + pin: + anyOf: + - type: 'null' + required: + - url + - html_url + - issue_url + - id + - node_id + - user + - created_at + - updated_at + - author_association + - performed_via_github_app + - body + - reactions + enterprise: *826 + installation: *827 + issue: + description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: *765 + issue_dependencies_summary: *766 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *359 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: *828 + repository: *829 + 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: &881 + 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: *857 + enterprise: *826 + installation: *827 + issue: + description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -145496,7 +148210,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -145845,6 +148559,7 @@ webhooks: sender: *4 required: - action + - changes - issue - comment - repository @@ -145861,7 +148576,7 @@ webhooks: - repository - organization - app - issue-comment-deleted: + issue-comment-pinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. @@ -145869,8 +148584,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/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: @@ -145914,180 +148629,14 @@ webhooks: content: application/json: schema: - title: issue_comment deleted event + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted - comment: &857 - 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 - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: *857 enterprise: *826 installation: *827 issue: @@ -146920,7 +149469,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -147287,7 +149836,7 @@ webhooks: - repository - organization - app - issue-comment-edited: + issue-comment-unpinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/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. @@ -147295,8 +149844,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/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: @@ -147340,25 +149889,13 @@ webhooks: content: application/json: schema: - title: issue_comment edited event + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: &881 - 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: *857 enterprise: *826 installation: *827 @@ -147829,8 +150366,6 @@ webhooks: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: - string @@ -148014,7 +150549,6 @@ webhooks: enum: - read - write - - admin organization_secrets: type: string enum: @@ -148195,7 +150729,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -148534,6 +151068,8 @@ webhooks: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -148544,7 +151080,6 @@ webhooks: sender: *4 required: - action - - changes - issue - comment - repository @@ -149707,11 +152242,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -149820,7 +152350,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -150730,11 +153260,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -150843,7 +153368,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -151886,11 +154411,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -151999,7 +154519,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -152931,11 +155451,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -153034,7 +155549,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -154079,11 +156594,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -154189,7 +156699,7 @@ webhooks: timeline_url: type: string format: uri - type: *358 + type: *359 title: description: Title of the issue type: string @@ -155097,11 +157607,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -155207,7 +157712,7 @@ webhooks: timeline_url: type: string format: uri - type: *358 + type: *359 title: description: Title of the issue type: string @@ -156150,11 +158655,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -156250,7 +158750,7 @@ webhooks: timeline_url: type: string format: uri - type: *358 + type: *359 title: description: Title of the issue type: string @@ -157162,11 +159662,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -157265,7 +159760,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -158147,11 +160642,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -158339,7 +160829,7 @@ webhooks: required: - login - id - type: *358 + type: *359 required: - id - number @@ -159541,11 +162031,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -159654,7 +162139,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -160553,11 +163038,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -160666,7 +163146,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -161601,11 +164081,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -161784,7 +164259,7 @@ webhooks: format: uri user_view_type: type: string - type: *358 + type: *359 organization: *828 repository: *829 sender: *4 @@ -162583,11 +165058,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -162696,7 +165166,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -163365,7 +165835,7 @@ webhooks: enterprise: *826 installation: *827 issue: *860 - type: *358 + type: *359 organization: *828 repository: *829 sender: *4 @@ -164441,11 +166911,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -164544,7 +167009,7 @@ webhooks: title: description: Title of the issue type: string - type: *358 + type: *359 updated_at: type: string format: date-time @@ -164791,7 +167256,7 @@ webhooks: enterprise: *826 installation: *827 issue: *860 - type: *358 + type: *359 organization: *828 repository: *829 sender: *4 @@ -166797,7 +169262,7 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *506 + head_commit: *507 required: - head_sha - head_ref @@ -172904,7 +175369,7 @@ webhooks: - closed installation: *827 organization: *828 - projects_v2: *389 + projects_v2: *390 sender: *4 required: - action @@ -172987,7 +175452,7 @@ webhooks: - created installation: *827 organization: *828 - projects_v2: *389 + projects_v2: *390 sender: *4 required: - action @@ -173070,7 +175535,7 @@ webhooks: - deleted installation: *827 organization: *828 - projects_v2: *389 + projects_v2: *390 sender: *4 required: - action @@ -173193,7 +175658,7 @@ webhooks: type: string installation: *827 organization: *828 - projects_v2: *389 + projects_v2: *390 sender: *4 required: - action @@ -173312,7 +175777,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *395 + content_type: *396 creator: *4 created_at: type: string @@ -174067,7 +176532,7 @@ webhooks: - reopened installation: *827 organization: *828 - projects_v2: *389 + projects_v2: *390 sender: *4 required: - action @@ -182060,7 +184525,7 @@ webhooks: enum: - demilestoned enterprise: *826 - milestone: *392 + milestone: *393 number: *878 organization: *828 pull_request: &880 @@ -194306,7 +196771,7 @@ webhooks: enum: - milestoned enterprise: *826 - milestone: *392 + milestone: *393 number: *878 organization: *828 pull_request: *880 @@ -239174,6 +241639,7 @@ webhooks: state: type: string enum: + - auto_dismissed - open enterprise: *826 installation: *827 @@ -241279,11 +243745,11 @@ webhooks: from: type: object properties: - security_and_analysis: *403 + security_and_analysis: *404 enterprise: *826 installation: *827 organization: *828 - repository: *444 + repository: *445 sender: *4 required: - changes @@ -246613,7 +249079,7 @@ webhooks: type: string required: - conclusion - deployment: *578 + deployment: *579 required: - action - repository @@ -246977,7 +249443,7 @@ webhooks: required: - status - steps - deployment: *578 + deployment: *579 required: - action - repository @@ -247205,7 +249671,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *578 + deployment: *579 required: - action - repository @@ -247434,7 +249900,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *578 + deployment: *579 required: - action - repository diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 8ea5eab45..f743bf58b 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -10005,6 +10005,48 @@ } } }, + "/enterprises/{enterprise}/installation": { + "get": { + "summary": "Get an enterprise installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find its installation on a particular enterprise.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-enterprise-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/installation" + }, + "examples": { + "default": { + "$ref": "#/components/examples/installation" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, "/enterprises/{enterprise}/license-sync-status": { "get": { "summary": "Get a license sync status", @@ -11400,7 +11442,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -11421,7 +11463,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -11590,7 +11632,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -11611,7 +11653,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -23493,7 +23535,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record": { "post": { "summary": "Create an artifact deployment record", - "description": "Create or update deployment records for an artifact associated with an organization.\nThis endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment.", + "description": "Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.", "tags": [ "orgs" ], @@ -23566,7 +23608,7 @@ }, "deployment_name": { "type": "string", - "description": "The name of the deployment." + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n" }, "tags": { "type": "object", @@ -25986,6 +26028,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" }, @@ -26468,6 +26520,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", @@ -99761,13 +99822,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": [ { @@ -99832,7 +99893,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" + "$ref": "#/components/schemas/webhook-issue-comment-pinned" } } } @@ -99845,7 +99906,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -99854,13 +99915,13 @@ } } }, - "issue-dependencies-blocked-by-removed": { + "issue-comment-unpinned": { "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", + "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-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -99925,7 +99986,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" } } } @@ -99938,7 +99999,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -99947,11 +100008,11 @@ } } }, - "issue-dependencies-blocking-added": { + "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 blocking another issue.", - "operationId": "issue-dependencies/blocking-added", + "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" }, @@ -100018,7 +100079,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" } } } @@ -100040,11 +100101,11 @@ } } }, - "issue-dependencies-blocking-removed": { + "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": "The blocking relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocking-removed", + "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" }, @@ -100111,7 +100172,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" } } } @@ -100133,106 +100194,13 @@ } } }, - "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 assigned to a user.", - "operationId": "issues/assigned", - "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-assigned" - } - } - } - }, - "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-closed": { + "issue-dependencies-blocking-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.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "summary": "This event occurs when there is activity relating to 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", "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": [ { @@ -100297,7 +100265,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" } } } @@ -100310,7 +100278,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -100319,13 +100287,13 @@ } } }, - "issues-deleted": { + "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 deleted.", - "operationId": "issues/deleted", + "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": [ { @@ -100390,7 +100358,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" } } } @@ -100403,7 +100371,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -100412,11 +100380,11 @@ } } }, - "issues-demilestoned": { + "issues-assigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100483,7 +100451,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -100505,11 +100473,11 @@ } } }, - "issues-edited": { + "issues-closed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100576,7 +100544,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -100598,11 +100566,11 @@ } } }, - "issues-labeled": { + "issues-deleted": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100669,7 +100637,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -100691,11 +100659,11 @@ } } }, - "issues-locked": { + "issues-demilestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100762,7 +100730,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -100784,11 +100752,11 @@ } } }, - "issues-milestoned": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100855,7 +100823,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -100877,11 +100845,11 @@ } } }, - "issues-opened": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100948,7 +100916,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -100970,11 +100938,11 @@ } } }, - "issues-pinned": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101041,7 +101009,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -101063,11 +101031,11 @@ } } }, - "issues-reopened": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101134,7 +101102,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -101156,11 +101124,11 @@ } } }, - "issues-transferred": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101227,7 +101195,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -101249,11 +101217,11 @@ } } }, - "issues-typed": { + "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": "An issue type was added to an issue.", - "operationId": "issues/typed", + "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" }, @@ -101320,7 +101288,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -101342,11 +101310,11 @@ } } }, - "issues-unassigned": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101413,7 +101381,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -101435,11 +101403,11 @@ } } }, - "issues-unlabeled": { + "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": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "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" }, @@ -101506,7 +101474,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -101528,11 +101496,11 @@ } } }, - "issues-unlocked": { + "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": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "description": "An issue type was added to an issue.", + "operationId": "issues/typed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101599,7 +101567,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-typed" } } } @@ -101621,11 +101589,11 @@ } } }, - "issues-unpinned": { + "issues-unassigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101692,7 +101660,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -101714,11 +101682,11 @@ } } }, - "issues-untyped": { + "issues-unlabeled": { "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 removed from an issue.", - "operationId": "issues/untyped", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101785,7 +101753,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -101807,13 +101775,13 @@ } } }, - "label-created": { + "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -101878,7 +101846,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -101891,7 +101859,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -101900,13 +101868,13 @@ } } }, - "label-deleted": { + "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -101971,7 +101939,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-unpinned" } } } @@ -101984,7 +101952,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -101993,11 +101961,104 @@ } } }, - "label-edited": { + "issues-untyped": { + "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 removed from an issue.", + "operationId": "issues/untyped", + "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-untyped" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "label-created": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, @@ -102064,7 +102125,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -102086,13 +102147,13 @@ } } }, - "marketplace-purchase-cancelled": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -102157,7 +102218,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -102170,20 +102231,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-changed": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -102248,7 +102311,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -102261,18 +102324,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change": { + "marketplace-purchase-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -102339,7 +102404,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" } } } @@ -102359,11 +102424,11 @@ } } }, - "marketplace-purchase-pending-change-cancelled": { + "marketplace-purchase-changed": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", - "operationId": "marketplace-purchase/pending-change-cancelled", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -102430,7 +102495,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" } } } @@ -102450,11 +102515,11 @@ } } }, - "marketplace-purchase-purchased": { + "marketplace-purchase-pending-change": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/purchased", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -102521,7 +102586,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" } } } @@ -102541,13 +102606,13 @@ } } }, - "member-added": { + "marketplace-purchase-pending-change-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -102612,7 +102677,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" } } } @@ -102625,21 +102690,109 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "marketplace" ] } } }, - "member-edited": { + "marketplace-purchase-purchased": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "marketplace_purchase", + "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "member-added": { "post": { "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, @@ -102706,7 +102859,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-member-added" } } } @@ -102729,11 +102882,11 @@ } } }, - "member-removed": { + "member-edited": { "post": { "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, @@ -102800,7 +102953,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-member-edited" } } } @@ -102823,13 +102976,13 @@ } } }, - "membership-added": { + "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -102894,7 +103047,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-member-removed" } } } @@ -102907,20 +103060,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "member", "supported-webhook-types": [ - "organization", "business", + "repository", + "organization", "app" ] } } }, - "membership-removed": { + "membership-added": { "post": { "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" }, @@ -102987,7 +103141,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-membership-added" } } } @@ -103009,16 +103163,13 @@ } } }, - "merge-group-checks-requested": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", - "operationId": "merge-group/checks-requested", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -103083,7 +103234,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-membership-removed" } } } @@ -103096,18 +103247,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "membership", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "merge-group-destroyed": { + "merge-group-checks-requested": { "post": { "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", - "operationId": "merge-group/destroyed", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" ], @@ -103177,7 +103330,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" } } } @@ -103197,13 +103350,16 @@ } } }, - "meta-deleted": { + "merge-group-destroyed": { "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", + "operationId": "merge-group/destroyed", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -103268,7 +103424,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" } } } @@ -103281,24 +103437,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "meta", + "subcategory": "merge_group", "supported-webhook-types": [ - "marketplace", - "business", - "repository", - "organization", "app" ] } } }, - "milestone-closed": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -103363,7 +103515,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-meta-deleted" } } } @@ -103376,8 +103528,10 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "meta", "supported-webhook-types": [ + "marketplace", + "business", "repository", "organization", "app" @@ -103385,11 +103539,11 @@ } } }, - "milestone-created": { + "milestone-closed": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -103456,7 +103610,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-milestone-closed" } } } @@ -103478,11 +103632,11 @@ } } }, - "milestone-deleted": { + "milestone-created": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -103549,7 +103703,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-milestone-created" } } } @@ -103571,11 +103725,11 @@ } } }, - "milestone-edited": { + "milestone-deleted": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -103642,7 +103796,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -103664,11 +103818,11 @@ } } }, - "milestone-opened": { + "milestone-edited": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -103735,7 +103889,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -103757,13 +103911,106 @@ } } }, - "org-block-blocked": { + "milestone-opened": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + }, + "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-milestone-opened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "org-block-blocked": { + "post": { + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -119549,14 +119796,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.", @@ -128077,7 +128316,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -128124,7 +128363,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -128171,7 +128410,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -128218,7 +128457,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -128265,7 +128504,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -132170,6 +132409,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -136732,7 +136981,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", @@ -154492,6 +154741,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -165858,6 +166117,16 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -166854,13 +167123,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -168302,13 +168564,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -175033,6 +175288,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } @@ -177152,13 +177408,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178005,13 +178254,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178851,13 +179093,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -183088,13 +183323,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -187837,13 +188065,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -188496,13 +188717,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -191999,6 +192213,16 @@ "type": "string", "format": "uri" }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] + }, "user": { "title": "User", "type": [ @@ -193086,13 +193310,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -194727,13 +194944,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -196377,13 +196587,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -197039,244 +197242,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" @@ -197285,7 +197262,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", @@ -197889,10 +197866,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -198147,8 +198121,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -198383,12 +198356,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", @@ -198559,9 +198526,103 @@ ] }, "assignee": { + "title": "User", "type": [ "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "assignees": { @@ -198609,9 +198670,46 @@ "labels": { "type": "array", "items": { - "type": [ - "object", - "null" + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] } }, @@ -198678,10 +198776,11 @@ "type": "string" }, "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": [ - "closed", - "open" + "open", + "closed" ] }, "timeline_url": { @@ -198761,8 +198860,10 @@ } }, "required": [ + "labels", "state", - "closed_at" + "locked", + "assignee" ] } ] @@ -198780,20 +198881,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" }, @@ -198801,355 +198906,3734 @@ "$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", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "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": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", + ], "enum": [ - "Bot", - "User", - "Organization" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-added": { + "title": "blocked by issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-removed": { + "title": "blocked by issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-added": { + "title": "blocking issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-removed": { + "title": "blocking issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issues-assigned": { + "title": "issues assigned event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "assigned" + ] + }, + "assignee": { + "$ref": "#/components/schemas/webhooks_user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-closed": { + "title": "issues closed event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/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", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "security_and_analysis", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "closed", + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "closed_at" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-deleted": { + "title": "issues deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -199756,13 +203240,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -201078,13 +204555,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -202369,13 +205839,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -203664,13 +207127,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -204998,13 +208454,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -206285,13 +209734,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -207542,13 +210984,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -209421,13 +212856,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -210782,13 +214210,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -212033,13 +215454,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -214125,13 +217539,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -314025,6 +317432,59 @@ } ] }, + "installation": { + "value": { + "id": 1, + "account": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/orgs/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "all", + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "client_id": "Iv1.ab1112223334445c", + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "created_at": "2018-02-09T20:51:14Z", + "updated_at": "2018-02-09T20:51:14Z", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + }, "get-license-sync-status": { "value": { "server_instances": [ @@ -314238,7 +317698,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -314256,7 +317716,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -314280,7 +317740,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -314301,41 +317761,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": [ @@ -319041,7 +322499,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", @@ -319103,59 +322560,6 @@ } ] }, - "installation": { - "value": { - "id": 1, - "account": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/orgs/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - }, - "repository_selection": "all", - "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/organizations/github/settings/installations/1", - "app_id": 1, - "client_id": "Iv1.ab1112223334445c", - "target_id": 1, - "target_type": "Organization", - "permissions": { - "checks": "write", - "metadata": "read", - "contents": "read" - }, - "events": [ - "push", - "pull_request" - ], - "created_at": "2018-02-09T20:51:14Z", - "updated_at": "2018-02-09T20:51:14Z", - "single_file_name": "config.yml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - } - }, "installation-paginated": { "value": { "total_count": 1, @@ -322554,61 +325958,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": [ @@ -336280,51 +339682,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": [ @@ -341904,7 +345304,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -341959,7 +345358,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -342230,7 +345628,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -342285,7 +345682,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -342543,7 +345939,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -342598,7 +345993,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -342884,7 +346278,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -342939,7 +346332,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 3da258649..e5a65e8b8 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -7203,6 +7203,36 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles + "/enterprises/{enterprise}/installation": + get: + summary: Get an enterprise installation for the authenticated app + description: |- + Enables an authenticated GitHub App to find its installation on a particular enterprise. + + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/get-enterprise-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/installation" + examples: + default: + "$ref": "#/components/examples/installation" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: apps + subcategory: apps "/enterprises/{enterprise}/license-sync-status": get: summary: Get a license sync status @@ -8208,7 +8238,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -8221,7 +8251,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '201': description: Response @@ -8336,7 +8366,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -8349,7 +8379,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '200': description: Response @@ -16878,8 +16908,19 @@ paths: post: summary: Create an artifact deployment record description: |- - Create or update deployment records for an artifact associated with an organization. - This endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment. + Create or update deployment records for an artifact associated + with an organization. + This endpoint allows you to record information about a specific + artifact, such as its name, digest, environments, cluster, and + deployment. + The deployment name has to be uniqe within a cluster (i.e a + combination of logical, physical environment and cluster) as it + identifies unique deployment. + Multiple requests for the same combination of logical, physical + environment, cluster and deployment name will only create one + record, successive request will update the existing record. + This allows for a stable tracking of a deployment where the actual + deployed artifact can change over time. tags: - orgs operationId: orgs/create-artifact-deployment-record @@ -16938,7 +16979,10 @@ paths: description: The deployment cluster. deployment_name: type: string - description: The name of the deployment. + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a cluster, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. tags: type: object description: The tags associated with the deployment. @@ -18688,6 +18732,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: @@ -19064,6 +19117,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 @@ -71917,18 +71978,18 @@ webhooks: - repository - organization - app - 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. + 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 issues more generally, use the `issues` event instead. + 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 permissions. - description: An issue was marked as blocked by another issue. - operationId: issue-dependencies/blocked-by-added + 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 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: - name: User-Agent in: header @@ -71970,7 +72031,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" + "$ref": "#/components/schemas/webhook-issue-comment-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71978,24 +72039,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issue-dependencies + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issue-dependencies-blocked-by-removed: + issue-comment-unpinned: post: summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + 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 issues more generally, use the `issues` event instead. + 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 permissions. - description: The blocked by relationship between an issue and another issue - was removed. - operationId: issue-dependencies/blocked-by-removed + 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 was unpinned. + operationId: issue-comment/unpinned 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: - name: User-Agent in: header @@ -72037,7 +72097,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72045,12 +72105,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issue-dependencies + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issue-dependencies-blocking-added: + 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. @@ -72058,8 +72118,8 @@ webhooks: 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 + 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: @@ -72103,7 +72163,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72116,7 +72176,7 @@ webhooks: - repository - organization - app - issue-dependencies-blocking-removed: + 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. @@ -72124,9 +72184,9 @@ webhooks: 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 + 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: @@ -72170,7 +72230,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72183,18 +72243,18 @@ webhooks: - repository - organization - app - issues-assigned: + issue-dependencies-blocking-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 assigned to a user. - operationId: issues/assigned + 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#issues + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -72236,7 +72296,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72244,23 +72304,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-closed: + 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. + 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 closed. - operationId: issues/closed + 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#issues + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -72302,7 +72363,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72310,12 +72371,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-deleted: + 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. @@ -72323,8 +72384,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was deleted. - operationId: issues/deleted + 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: @@ -72368,7 +72429,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issues-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72381,7 +72442,7 @@ webhooks: - repository - organization - app - issues-demilestoned: + 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. @@ -72389,8 +72450,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was removed from a milestone. - operationId: issues/demilestoned + description: An issue was closed. + operationId: issues/closed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72434,7 +72495,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72447,7 +72508,7 @@ webhooks: - repository - organization - app - issues-edited: + 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. @@ -72455,8 +72516,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: The title or body on an issue was edited. - operationId: issues/edited + description: An issue was deleted. + operationId: issues/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72500,7 +72561,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72513,7 +72574,7 @@ webhooks: - repository - organization - app - issues-labeled: + 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. @@ -72521,8 +72582,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + description: An issue was removed from a milestone. + operationId: issues/demilestoned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72566,7 +72627,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72579,7 +72640,7 @@ webhooks: - repository - organization - app - issues-locked: + 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. @@ -72587,9 +72648,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + 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: @@ -72633,7 +72693,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72646,7 +72706,7 @@ webhooks: - repository - organization - app - issues-milestoned: + 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. @@ -72654,8 +72714,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: 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: @@ -72699,7 +72759,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72712,7 +72772,7 @@ webhooks: - repository - organization - app - issues-opened: + 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. @@ -72720,9 +72780,9 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + 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: @@ -72766,7 +72826,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72779,7 +72839,7 @@ webhooks: - repository - organization - app - issues-pinned: + 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. @@ -72787,9 +72847,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + 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: @@ -72833,7 +72892,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72846,7 +72905,7 @@ webhooks: - repository - organization - app - issues-reopened: + 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. @@ -72854,8 +72913,9 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: 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: @@ -72899,7 +72959,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72912,7 +72972,7 @@ webhooks: - repository - organization - app - issues-transferred: + 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. @@ -72920,9 +72980,9 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: 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 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: @@ -72966,7 +73026,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72979,7 +73039,7 @@ webhooks: - repository - organization - app - issues-typed: + 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. @@ -72987,8 +73047,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was added to an issue. - operationId: issues/typed + 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: @@ -73032,7 +73092,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73045,7 +73105,7 @@ webhooks: - repository - organization - app - issues-unassigned: + 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. @@ -73053,8 +73113,9 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A user was unassigned from an issue. - operationId: issues/unassigned + 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: @@ -73098,7 +73159,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73111,7 +73172,7 @@ webhooks: - repository - organization - app - issues-unlabeled: + 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. @@ -73119,8 +73180,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was removed from an issue. - operationId: issues/unlabeled + 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: @@ -73164,7 +73225,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-typed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73177,7 +73238,7 @@ webhooks: - repository - organization - app - issues-unlocked: + 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. @@ -73185,9 +73246,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/unlocked + 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: @@ -73231,7 +73291,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73244,7 +73304,7 @@ webhooks: - repository - organization - app - issues-unpinned: + issues-unlabeled: 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. @@ -73252,9 +73312,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was unpinned from a repository. For more information, - see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/unpinned + description: A label was removed from an issue. + operationId: issues/unlabeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -73298,7 +73357,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73311,7 +73370,7 @@ webhooks: - repository - organization - app - issues-untyped: + issues-unlocked: 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. @@ -73319,8 +73378,142 @@ 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 removed from an issue. - operationId: issues/untyped + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/unlocked + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#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-unlocked" + 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-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. + + 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 unpinned from a repository. For more information, + see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/unpinned + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-unpinned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-untyped: + 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 removed from an issue. + operationId: issues/untyped externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -86090,13 +86283,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 @@ -92633,7 +92819,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. @@ -92667,7 +92853,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. @@ -92701,7 +92887,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. @@ -92735,7 +92921,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. @@ -92769,7 +92955,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. @@ -95588,6 +95774,10 @@ components: - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - id - node_id @@ -98969,7 +99159,7 @@ components: cli: type: string description: The organization policy for allowing or disallowing Copilot - in the CLI. + CLI. enum: - enabled - disabled @@ -111854,6 +112044,10 @@ components: - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - event - actor @@ -119943,6 +120137,10 @@ components: required: - login - id + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - url - html_url @@ -120687,11 +120885,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -121763,11 +121956,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -126818,6 +127006,7 @@ components: state: type: string enum: + - auto_dismissed - open secret-scanning-alert-resolution-webhook: type: @@ -128336,11 +128525,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -128980,11 +129164,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129617,11 +129796,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -132792,11 +132966,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136138,11 +136307,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136631,11 +136795,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139099,6 +139258,10 @@ components: description: URL for the issue comment type: string format: uri + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" user: title: User type: @@ -139912,11 +140075,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -141115,11 +141273,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -142325,11 +142478,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -142795,182 +142943,23 @@ components: - comment - repository - sender - webhook-issue-dependencies-blocked-by-added: - title: blocked by issue added event + webhook-issue-comment-pinned: + title: issue_comment pinned event type: object properties: action: type: string enum: - - blocked_by_added - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_repo: - "$ref": "#/components/schemas/repository" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issue-dependencies-blocked-by-removed: - title: blocked by issue removed event - type: object - properties: - action: - type: string - enum: - - blocked_by_removed - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_repo: - "$ref": "#/components/schemas/repository" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issue-dependencies-blocking-added: - title: blocking issue added event - type: object - properties: - action: - type: string - enum: - - blocking_added - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocked_issue_repo: - "$ref": "#/components/schemas/repository" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issue-dependencies-blocking-removed: - title: blocking issue removed event - type: object - properties: - action: - type: string - enum: - - blocking_removed - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocked_issue_repo: - "$ref": "#/components/schemas/repository" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issues-assigned: - title: issues assigned event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - assigned - assignee: - "$ref": "#/components/schemas/webhooks_user" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - "$ref": "#/components/schemas/webhooks_issue" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - issue - - repository - - sender - webhook-issues-closed: - title: issues closed event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - closed + - pinned + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: description: The [issue](https://docs.github.com/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) @@ -143435,9 +143424,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - reminder - - pull_request_review_thread external_url: type: - string @@ -143621,7 +143607,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -143788,10 +143773,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 @@ -143919,255 +143900,2827 @@ components: - string - 'null' assignee: - type: - - object - - 'null' - assignees: - type: array - items: - type: - - object - - 'null' - author_association: - type: string - body: - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - type: - - object - - 'null' - labels_url: - type: string - locked: - type: boolean - milestone: - type: - - object - - 'null' - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: - - object - - 'null' - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - enum: - - closed - - open - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - format: int64 - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - required: - - state - - closed_at - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - issue - - repository - - sender - webhook-issues-deleted: - title: issues deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-comment-unpinned: + title: issue_comment unpinned event + type: object + properties: + action: + type: string + enum: + - unpinned + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-dependencies-blocked-by-added: + title: blocked by issue added event + type: object + properties: + action: + type: string + enum: + - blocked_by_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocked-by-removed: + title: blocked by issue removed event + type: object + properties: + action: + type: string + enum: + - blocked_by_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocking-added: + title: blocking issue added event + type: object + properties: + action: + type: string + enum: + - blocking_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocking-removed: + title: blocking issue removed event + type: object + properties: + action: + type: string + enum: + - blocking_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issues-assigned: + title: issues assigned event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - assigned + assignee: + "$ref": "#/components/schemas/webhooks_user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - repository + - sender + webhook-issues-closed: + title: issues closed event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - closed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - security_and_analysis + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + type: + - object + - 'null' + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + type: + - object + - 'null' + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + type: string + enum: + - closed + - open + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - state + - closed_at + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - repository + - sender + webhook-issues-deleted: + title: issues deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: title: User type: - object @@ -144792,11 +147345,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -145781,11 +148329,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -146732,11 +149275,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -147695,11 +150233,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -148692,11 +151225,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -149648,11 +152176,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -150576,11 +153099,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -151975,11 +154493,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -152992,11 +155505,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -153916,11 +156424,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -155478,11 +157981,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -230767,6 +233265,53 @@ components: received_events_url: https://api.github.com/users/monalisa/received_events type: User site_admin: false + installation: + value: + id: 1 + account: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/orgs/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + repository_selection: all + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + client_id: Iv1.ab1112223334445c + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + created_at: '2018-02-09T20:51:14Z' + updated_at: '2018-02-09T20:51:14Z' + single_file_name: config.yml + has_multiple_single_files: true + single_file_paths: + - config.yml + - ".github/issue_TEMPLATE.md" + app_slug: github-actions + suspended_at: + suspended_by: get-license-sync-status: value: server_instances: @@ -230912,7 +233457,7 @@ components: value: id: 21 name: super cool ruleset - target: repository + target: branch source_type: Enterprise source: my-enterprise enforcement: active @@ -230924,7 +233469,7 @@ components: include: - "~ALL" rules: - - type: repository_delete + - type: deletion node_id: RRS_lACkVXNlcgQB _links: self: @@ -230939,7 +233484,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 @@ -230952,11 +233497,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 @@ -234957,7 +237502,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' @@ -234996,53 +237540,6 @@ components: rate_limited_request_count: 13 last_request_timestamp: '2024-09-18T15:43:03Z' last_rate_limited_timestamp: '2024-09-18T06:30:09Z' - installation: - value: - id: 1 - account: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/orgs/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - received_events_url: https://api.github.com/users/github/received_events - type: Organization - site_admin: false - repository_selection: all - access_tokens_url: https://api.github.com/app/installations/1/access_tokens - repositories_url: https://api.github.com/installation/repositories - html_url: https://github.com/organizations/github/settings/installations/1 - app_id: 1 - client_id: Iv1.ab1112223334445c - target_id: 1 - target_type: Organization - permissions: - checks: write - metadata: read - contents: read - events: - - push - - pull_request - created_at: '2018-02-09T20:51:14Z' - updated_at: '2018-02-09T20:51:14Z' - single_file_name: config.yml - has_multiple_single_files: true - single_file_paths: - - config.yml - - ".github/issue_TEMPLATE.md" - app_slug: github-actions - suspended_at: - suspended_by: installation-paginated: value: total_count: 1 @@ -237980,11 +240477,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 @@ -249733,11 +252230,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 @@ -254523,7 +257020,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -254574,7 +257070,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -254818,7 +257313,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -254869,7 +257363,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -255101,7 +257594,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -255152,7 +257644,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -255409,7 +257900,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -255460,7 +257950,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 8ea5eab45..f743bf58b 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -10005,6 +10005,48 @@ } } }, + "/enterprises/{enterprise}/installation": { + "get": { + "summary": "Get an enterprise installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find its installation on a particular enterprise.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-enterprise-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/installation" + }, + "examples": { + "default": { + "$ref": "#/components/examples/installation" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, "/enterprises/{enterprise}/license-sync-status": { "get": { "summary": "Get a license sync status", @@ -11400,7 +11442,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -11421,7 +11463,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -11590,7 +11632,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -11611,7 +11653,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -23493,7 +23535,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record": { "post": { "summary": "Create an artifact deployment record", - "description": "Create or update deployment records for an artifact associated with an organization.\nThis endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment.", + "description": "Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.", "tags": [ "orgs" ], @@ -23566,7 +23608,7 @@ }, "deployment_name": { "type": "string", - "description": "The name of the deployment." + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n" }, "tags": { "type": "object", @@ -25986,6 +26028,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" }, @@ -26468,6 +26520,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", @@ -99761,13 +99822,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": [ { @@ -99832,7 +99893,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" + "$ref": "#/components/schemas/webhook-issue-comment-pinned" } } } @@ -99845,7 +99906,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -99854,13 +99915,13 @@ } } }, - "issue-dependencies-blocked-by-removed": { + "issue-comment-unpinned": { "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", + "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-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -99925,7 +99986,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" } } } @@ -99938,7 +99999,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -99947,11 +100008,11 @@ } } }, - "issue-dependencies-blocking-added": { + "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 blocking another issue.", - "operationId": "issue-dependencies/blocking-added", + "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" }, @@ -100018,7 +100079,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" } } } @@ -100040,11 +100101,11 @@ } } }, - "issue-dependencies-blocking-removed": { + "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": "The blocking relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocking-removed", + "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" }, @@ -100111,7 +100172,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" } } } @@ -100133,106 +100194,13 @@ } } }, - "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 assigned to a user.", - "operationId": "issues/assigned", - "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-assigned" - } - } - } - }, - "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-closed": { + "issue-dependencies-blocking-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.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "summary": "This event occurs when there is activity relating to 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", "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": [ { @@ -100297,7 +100265,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" } } } @@ -100310,7 +100278,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -100319,13 +100287,13 @@ } } }, - "issues-deleted": { + "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 deleted.", - "operationId": "issues/deleted", + "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": [ { @@ -100390,7 +100358,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" } } } @@ -100403,7 +100371,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -100412,11 +100380,11 @@ } } }, - "issues-demilestoned": { + "issues-assigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100483,7 +100451,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -100505,11 +100473,11 @@ } } }, - "issues-edited": { + "issues-closed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100576,7 +100544,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -100598,11 +100566,11 @@ } } }, - "issues-labeled": { + "issues-deleted": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100669,7 +100637,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -100691,11 +100659,11 @@ } } }, - "issues-locked": { + "issues-demilestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100762,7 +100730,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -100784,11 +100752,11 @@ } } }, - "issues-milestoned": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100855,7 +100823,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -100877,11 +100845,11 @@ } } }, - "issues-opened": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100948,7 +100916,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -100970,11 +100938,11 @@ } } }, - "issues-pinned": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101041,7 +101009,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -101063,11 +101031,11 @@ } } }, - "issues-reopened": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101134,7 +101102,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -101156,11 +101124,11 @@ } } }, - "issues-transferred": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101227,7 +101195,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -101249,11 +101217,11 @@ } } }, - "issues-typed": { + "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": "An issue type was added to an issue.", - "operationId": "issues/typed", + "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" }, @@ -101320,7 +101288,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -101342,11 +101310,11 @@ } } }, - "issues-unassigned": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101413,7 +101381,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -101435,11 +101403,11 @@ } } }, - "issues-unlabeled": { + "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": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "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" }, @@ -101506,7 +101474,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -101528,11 +101496,11 @@ } } }, - "issues-unlocked": { + "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": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "description": "An issue type was added to an issue.", + "operationId": "issues/typed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101599,7 +101567,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-typed" } } } @@ -101621,11 +101589,11 @@ } } }, - "issues-unpinned": { + "issues-unassigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101692,7 +101660,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -101714,11 +101682,11 @@ } } }, - "issues-untyped": { + "issues-unlabeled": { "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 removed from an issue.", - "operationId": "issues/untyped", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101785,7 +101753,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -101807,13 +101775,13 @@ } } }, - "label-created": { + "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -101878,7 +101846,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -101891,7 +101859,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -101900,13 +101868,13 @@ } } }, - "label-deleted": { + "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -101971,7 +101939,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-unpinned" } } } @@ -101984,7 +101952,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -101993,11 +101961,104 @@ } } }, - "label-edited": { + "issues-untyped": { + "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 removed from an issue.", + "operationId": "issues/untyped", + "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-untyped" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "label-created": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, @@ -102064,7 +102125,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -102086,13 +102147,13 @@ } } }, - "marketplace-purchase-cancelled": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -102157,7 +102218,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -102170,20 +102231,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-changed": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -102248,7 +102311,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -102261,18 +102324,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change": { + "marketplace-purchase-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -102339,7 +102404,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" } } } @@ -102359,11 +102424,11 @@ } } }, - "marketplace-purchase-pending-change-cancelled": { + "marketplace-purchase-changed": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", - "operationId": "marketplace-purchase/pending-change-cancelled", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -102430,7 +102495,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" } } } @@ -102450,11 +102515,11 @@ } } }, - "marketplace-purchase-purchased": { + "marketplace-purchase-pending-change": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/purchased", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -102521,7 +102586,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" } } } @@ -102541,13 +102606,13 @@ } } }, - "member-added": { + "marketplace-purchase-pending-change-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -102612,7 +102677,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" } } } @@ -102625,21 +102690,109 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "marketplace" ] } } }, - "member-edited": { + "marketplace-purchase-purchased": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "marketplace_purchase", + "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "member-added": { "post": { "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, @@ -102706,7 +102859,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-member-added" } } } @@ -102729,11 +102882,11 @@ } } }, - "member-removed": { + "member-edited": { "post": { "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, @@ -102800,7 +102953,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-member-edited" } } } @@ -102823,13 +102976,13 @@ } } }, - "membership-added": { + "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -102894,7 +103047,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-member-removed" } } } @@ -102907,20 +103060,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "member", "supported-webhook-types": [ - "organization", "business", + "repository", + "organization", "app" ] } } }, - "membership-removed": { + "membership-added": { "post": { "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" }, @@ -102987,7 +103141,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-membership-added" } } } @@ -103009,16 +103163,13 @@ } } }, - "merge-group-checks-requested": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", - "operationId": "merge-group/checks-requested", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -103083,7 +103234,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-membership-removed" } } } @@ -103096,18 +103247,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "membership", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "merge-group-destroyed": { + "merge-group-checks-requested": { "post": { "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", - "operationId": "merge-group/destroyed", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" ], @@ -103177,7 +103330,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" } } } @@ -103197,13 +103350,16 @@ } } }, - "meta-deleted": { + "merge-group-destroyed": { "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", + "operationId": "merge-group/destroyed", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -103268,7 +103424,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" } } } @@ -103281,24 +103437,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "meta", + "subcategory": "merge_group", "supported-webhook-types": [ - "marketplace", - "business", - "repository", - "organization", "app" ] } } }, - "milestone-closed": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -103363,7 +103515,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-meta-deleted" } } } @@ -103376,8 +103528,10 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "meta", "supported-webhook-types": [ + "marketplace", + "business", "repository", "organization", "app" @@ -103385,11 +103539,11 @@ } } }, - "milestone-created": { + "milestone-closed": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -103456,7 +103610,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-milestone-closed" } } } @@ -103478,11 +103632,11 @@ } } }, - "milestone-deleted": { + "milestone-created": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -103549,7 +103703,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-milestone-created" } } } @@ -103571,11 +103725,11 @@ } } }, - "milestone-edited": { + "milestone-deleted": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -103642,7 +103796,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -103664,11 +103818,11 @@ } } }, - "milestone-opened": { + "milestone-edited": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -103735,7 +103889,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -103757,13 +103911,106 @@ } } }, - "org-block-blocked": { + "milestone-opened": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + }, + "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-milestone-opened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "org-block-blocked": { + "post": { + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -119549,14 +119796,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.", @@ -128077,7 +128316,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -128124,7 +128363,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -128171,7 +128410,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -128218,7 +128457,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -128265,7 +128504,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -132170,6 +132409,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -136732,7 +136981,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", @@ -154492,6 +154741,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -165858,6 +166117,16 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -166854,13 +167123,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -168302,13 +168564,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -175033,6 +175288,7 @@ "state": { "type": "string", "enum": [ + "auto_dismissed", "open" ] } @@ -177152,13 +177408,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178005,13 +178254,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178851,13 +179093,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -183088,13 +183323,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -187837,13 +188065,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -188496,13 +188717,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -191999,6 +192213,16 @@ "type": "string", "format": "uri" }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] + }, "user": { "title": "User", "type": [ @@ -193086,13 +193310,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -194727,13 +194944,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -196377,13 +196587,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -197039,244 +197242,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" @@ -197285,7 +197262,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", @@ -197889,10 +197866,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -198147,8 +198121,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -198383,12 +198356,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", @@ -198559,9 +198526,103 @@ ] }, "assignee": { + "title": "User", "type": [ "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "assignees": { @@ -198609,9 +198670,46 @@ "labels": { "type": "array", "items": { - "type": [ - "object", - "null" + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] } }, @@ -198678,10 +198776,11 @@ "type": "string" }, "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": [ - "closed", - "open" + "open", + "closed" ] }, "timeline_url": { @@ -198761,8 +198860,10 @@ } }, "required": [ + "labels", "state", - "closed_at" + "locked", + "assignee" ] } ] @@ -198780,20 +198881,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" }, @@ -198801,355 +198906,3734 @@ "$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", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "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": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", + ], "enum": [ - "Bot", - "User", - "Organization" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-added": { + "title": "blocked by issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-removed": { + "title": "blocked by issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-added": { + "title": "blocking issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-removed": { + "title": "blocking issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issues-assigned": { + "title": "issues assigned event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "assigned" + ] + }, + "assignee": { + "$ref": "#/components/schemas/webhooks_user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-closed": { + "title": "issues closed event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/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", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "security_and_analysis", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "closed", + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "closed_at" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-deleted": { + "title": "issues deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -199756,13 +203240,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -201078,13 +204555,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -202369,13 +205839,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -203664,13 +207127,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -204998,13 +208454,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -206285,13 +209734,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -207542,13 +210984,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -209421,13 +212856,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -210782,13 +214210,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -212033,13 +215454,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -214125,13 +217539,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -314025,6 +317432,59 @@ } ] }, + "installation": { + "value": { + "id": 1, + "account": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/orgs/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "all", + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "client_id": "Iv1.ab1112223334445c", + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "created_at": "2018-02-09T20:51:14Z", + "updated_at": "2018-02-09T20:51:14Z", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + }, "get-license-sync-status": { "value": { "server_instances": [ @@ -314238,7 +317698,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -314256,7 +317716,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -314280,7 +317740,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -314301,41 +317761,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": [ @@ -319041,7 +322499,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", @@ -319103,59 +322560,6 @@ } ] }, - "installation": { - "value": { - "id": 1, - "account": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/orgs/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - }, - "repository_selection": "all", - "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/organizations/github/settings/installations/1", - "app_id": 1, - "client_id": "Iv1.ab1112223334445c", - "target_id": 1, - "target_type": "Organization", - "permissions": { - "checks": "write", - "metadata": "read", - "contents": "read" - }, - "events": [ - "push", - "pull_request" - ], - "created_at": "2018-02-09T20:51:14Z", - "updated_at": "2018-02-09T20:51:14Z", - "single_file_name": "config.yml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - } - }, "installation-paginated": { "value": { "total_count": 1, @@ -322554,61 +325958,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": [ @@ -336280,51 +339682,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": [ @@ -341904,7 +345304,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -341959,7 +345358,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -342230,7 +345628,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -342285,7 +345682,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -342543,7 +345939,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -342598,7 +345993,6 @@ "repository_hooks": "write", "reposit{"code":"deadline_exceeded","msg":"operation timed out"}