diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 145f477296..98e2f2f74e 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 @@ -36331,6 +36331,12 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" } ], "responses": { @@ -72578,6 +72584,12 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" } ], "responses": { @@ -72646,7 +72658,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -72774,7 +72786,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -106361,6 +106373,99 @@ } } }, + "pull-request-stacked": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-stacked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", @@ -109817,11 +109922,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-metadata-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "Metadata was created for a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -109888,7 +109993,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-created" } } } @@ -109899,7 +110004,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -109910,11 +110014,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-metadata-removed": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "Metadata was removed from a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -109981,7 +110085,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-removed" } } } @@ -109992,7 +110096,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -110003,11 +110106,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-publicly-leaked": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110074,7 +110177,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -110096,11 +110199,11 @@ } } }, - "secret-scanning-alert-unassigned": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was unassigned.", - "operationId": "secret-scanning-alert/unassigned", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110167,7 +110270,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -110189,11 +110292,11 @@ } } }, - "secret-scanning-alert-validated": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was validated.", - "operationId": "secret-scanning-alert/validated", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110260,7 +110363,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -110282,13 +110385,13 @@ } } }, - "secret-scanning-scan-completed": { + "secret-scanning-alert-unassigned": { "post": { - "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning scan was completed.", - "operationId": "secret-scanning-scan/completed", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110310,7 +110413,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_scan", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110353,7 +110456,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -110366,7 +110469,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_scan", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -110375,13 +110478,13 @@ } } }, - "security-advisory-published": { + "secret-scanning-alert-validated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A security advisory was published to the GitHub community.", - "operationId": "security-advisory/published", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110403,7 +110506,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110446,7 +110549,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -110459,20 +110562,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-updated": { + "secret-scanning-scan-completed": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed.", - "operationId": "security-advisory/updated", + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning scan was completed.", + "operationId": "secret-scanning-scan/completed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" }, "parameters": [ { @@ -110494,7 +110599,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_scan", "schema": { "type": "string" } @@ -110537,7 +110642,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -110550,18 +110655,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_scan", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-withdrawn": { + "security-advisory-published": { "post": { "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A previously published security advisory was withdrawn.", - "operationId": "security-advisory/withdrawn", + "description": "A security advisory was published to the GitHub community.", + "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, @@ -110628,7 +110735,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -110648,12 +110755,13 @@ } } }, - "security-and-analysis": { + "security-advisory-updated": { "post": { - "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "operationId": "security-and-analysis", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -110675,7 +110783,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_and_analysis", + "example": "security_advisory", "schema": { "type": "string" } @@ -110718,7 +110826,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -110731,22 +110839,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "security_advisory", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "sponsorship-cancelled": { + "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/cancelled", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -110768,7 +110874,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_advisory", "schema": { "type": "string" } @@ -110811,7 +110917,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -110824,20 +110930,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_advisory", "supported-webhook-types": [ - "sponsors_listing" + "app" ] } } }, - "sponsorship-created": { + "security-and-analysis": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", - "operationId": "sponsorship/created", + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "operationId": "security-and-analysis", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -110859,7 +110964,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_and_analysis", "schema": { "type": "string" } @@ -110902,7 +111007,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -110915,18 +111020,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_and_analysis", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "sponsorship-edited": { + "sponsorship-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", - "operationId": "sponsorship/edited", + "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -110993,7 +111100,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -111013,11 +111120,11 @@ } } }, - "sponsorship-pending-cancellation": { + "sponsorship-created": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/pending-cancellation", + "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", + "operationId": "sponsorship/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111084,7 +111191,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -111104,11 +111211,11 @@ } } }, - "sponsorship-pending-tier-change": { + "sponsorship-edited": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", - "operationId": "sponsorship/pending-tier-change", + "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", + "operationId": "sponsorship/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111175,7 +111282,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -111195,11 +111302,11 @@ } } }, - "sponsorship-tier-changed": { + "sponsorship-pending-cancellation": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", - "operationId": "sponsorship/tier-changed", + "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/pending-cancellation", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111266,7 +111373,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -111286,13 +111393,13 @@ } } }, - "star-created": { + "sponsorship-pending-tier-change": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone starred a repository.", - "operationId": "star/created", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", + "operationId": "sponsorship/pending-tier-change", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111314,7 +111421,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111357,7 +111464,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -111370,22 +111477,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "star-deleted": { + "sponsorship-tier-changed": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone unstarred the repository.", - "operationId": "star/deleted", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", + "operationId": "sponsorship/tier-changed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111407,7 +111512,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111450,7 +111555,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -111463,21 +111568,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "status": { + "star-created": { "post": { - "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", - "operationId": "status", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone starred a repository.", + "operationId": "star/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -111499,7 +111603,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "status", + "example": "star", "schema": { "type": "string" } @@ -111542,7 +111646,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -111555,7 +111659,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111564,13 +111668,13 @@ } } }, - "sub-issues-parent-issue-added": { + "star-deleted": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was added to an issue.", - "operationId": "sub-issues/parent-issue-added", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone unstarred the repository.", + "operationId": "star/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -111592,7 +111696,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "star", "schema": { "type": "string" } @@ -111635,7 +111739,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -111648,7 +111752,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111657,13 +111761,12 @@ } } }, - "sub-issues-parent-issue-removed": { + "status": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was removed from an issue.", - "operationId": "sub-issues/parent-issue-removed", + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "operationId": "status", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -111685,7 +111788,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "status", "schema": { "type": "string" } @@ -111728,7 +111831,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" } } } @@ -111741,7 +111844,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "status", "supported-webhook-types": [ "repository", "organization", @@ -111750,11 +111853,11 @@ } } }, - "sub-issues-sub-issue-added": { + "sub-issues-parent-issue-added": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was added to an issue.", - "operationId": "sub-issues/sub-issue-added", + "description": "A parent issue was added to an issue.", + "operationId": "sub-issues/parent-issue-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -111821,7 +111924,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -111843,11 +111946,11 @@ } } }, - "sub-issues-sub-issue-removed": { + "sub-issues-parent-issue-removed": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was removed from an issue.", - "operationId": "sub-issues/sub-issue-removed", + "description": "A parent issue was removed from an issue.", + "operationId": "sub-issues/parent-issue-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -111914,7 +112017,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -111936,12 +112039,13 @@ } } }, - "team-add": { + "sub-issues-sub-issue-added": { "post": { - "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "operationId": "team-add", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was added to an issue.", + "operationId": "sub-issues/sub-issue-added", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -111963,7 +112067,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team_add", + "example": "sub_issues", "schema": { "type": "string" } @@ -112006,7 +112110,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -112019,7 +112123,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "sub-issues", "supported-webhook-types": [ "repository", "organization", @@ -112028,13 +112132,13 @@ } } }, - "team-added-to-repository": { + "sub-issues-sub-issue-removed": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was granted access to a repository.", - "operationId": "team/added-to-repository", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was removed from an issue.", + "operationId": "sub-issues/sub-issue-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -112056,7 +112160,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "sub_issues", "schema": { "type": "string" } @@ -112099,7 +112203,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -112112,22 +112216,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "sub-issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-created": { + "team-add": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was created.", - "operationId": "team/created", + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "operationId": "team-add", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -112149,7 +112252,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "team_add", "schema": { "type": "string" } @@ -112192,7 +112295,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -112205,20 +112308,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "team_add", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-deleted": { + "team-added-to-repository": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was deleted.", - "operationId": "team/deleted", + "description": "A team was granted access to a repository.", + "operationId": "team/added-to-repository", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112285,7 +112388,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -112307,11 +112410,11 @@ } } }, - "team-edited": { + "team-created": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name, description, or visibility of a team was changed.", - "operationId": "team/edited", + "description": "A team was created.", + "operationId": "team/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112378,7 +112481,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -112400,11 +112503,11 @@ } } }, - "team-removed-from-repository": { + "team-deleted": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team's access to a repository was removed.", - "operationId": "team/removed-from-repository", + "description": "A team was deleted.", + "operationId": "team/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112471,7 +112574,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-deleted" } } } @@ -112493,13 +112596,13 @@ } } }, - "watch-started": { + "team-edited": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone started watching the repository.", - "operationId": "watch/started", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name, description, or visibility of a team was changed.", + "operationId": "team/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -112521,7 +112624,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "watch", + "example": "team", "schema": { "type": "string" } @@ -112564,7 +112667,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-edited" } } } @@ -112577,21 +112680,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "watch", + "subcategory": "team", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "workflow-dispatch": { + "team-removed-from-repository": { "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "workflow-dispatch", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team's access to a repository was removed.", + "operationId": "team/removed-from-repository", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -112613,7 +112717,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_dispatch", + "example": "team", "schema": { "type": "string" } @@ -112656,7 +112760,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" } } } @@ -112669,20 +112773,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_dispatch", + "subcategory": "team", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "workflow-job-completed": { + "watch-started": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", - "operationId": "workflow-job/completed", + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone started watching the repository.", + "operationId": "watch/started", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" }, "parameters": [ { @@ -112704,7 +112810,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "watch", "schema": { "type": "string" } @@ -112747,7 +112853,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-watch-started" } } } @@ -112760,9 +112866,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "watch", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -112770,13 +112875,12 @@ } } }, - "workflow-job-in-progress": { + "workflow-dispatch": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run started processing on a runner.", - "operationId": "workflow-job/in-progress", + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "workflow-dispatch", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" }, "parameters": [ { @@ -112798,7 +112902,192 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "workflow_dispatch", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-dispatch" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "workflow-job-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", + "operationId": "workflow-job/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_job", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run started processing on a runner.", + "operationId": "workflow-job/in-progress", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_job", "schema": { "type": "string" } @@ -133089,6 +133378,9 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -152769,6 +153061,255 @@ } } }, + "secret-scanning-alert-metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } + }, + "secret-scanning-alert-with-metadata": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/alert-updated-at" + } + ] + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise." + }, + "is_base64_encoded": { + "type": [ + "boolean", + "null" + ], + "description": "A boolean value representing whether or not alert is base64 encoded" + }, + "first_location_detected": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/secret-scanning-first-detected-location" + } + ] + }, + "has_more_locations": { + "type": "boolean", + "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "metadata": { + "$ref": "#/components/schemas/secret-scanning-alert-metadata" + } + } + }, "secret-scanning-alert-resolution-comment": { "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": [ @@ -169330,6 +169871,9 @@ "$ref": "#/components/schemas/simple-user" } ] + }, + "metadata": { + "$ref": "#/components/schemas/secret-scanning-alert-metadata" } } }, @@ -269291,8 +269835,2999 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": [ + "string", + "null" + ] + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "review": { + "$ref": "#/components/schemas/webhooks_review" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "review", + "pull_request", + "repository", + "sender" + ] + }, + "webhook-pull-request-review-thread-resolved": { + "title": "pull_request_review_thread resolved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolved" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Simple Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, "url": { @@ -269754,23 +273289,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -269970,23 +273488,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -270042,11 +273543,6 @@ "type": "string", "format": "uri" }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "type": "boolean", - "default": false - }, "visibility": { "type": "string", "enum": [ @@ -270587,23 +274083,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -270803,23 +274282,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -270875,11 +274337,6 @@ "type": "string", "format": "uri" }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "type": "boolean", - "default": false - }, "visibility": { "type": "string", "enum": [ @@ -271266,8 +274723,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -271929,29 +275385,425 @@ "repository": { "$ref": "#/components/schemas/repository-webhooks" }, - "review": { - "$ref": "#/components/schemas/webhooks_review" - }, "sender": { "$ref": "#/components/schemas/simple-user" + }, + "thread": { + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "title": "Pull Request Review Comment", + "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "type": "string" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies.", + "type": "integer" + }, + "original_start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "enum": [ + "LEFT", + "RIGHT" + ] + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": [ + "string", + "null" + ], + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the pull request review comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links", + "start_line", + "original_start_line", + "original_line", + "line", + "start_side", + "side", + "reactions" + ] + } + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "node_id", + "comments" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ "action", - "review", + "thread", "pull_request", - "repository", - "sender" + "repository" ] }, - "webhook-pull-request-review-thread-resolved": { - "title": "pull_request_review_thread resolved event", + "webhook-pull-request-review-thread-unresolved": { + "title": "pull_request_review_thread unresolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unresolved" ] }, "enterprise": { @@ -272329,10 +276181,7 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": [ - "string", - "null" - ] + "type": "string" }, "enabled_by": { "title": "User", @@ -273242,10 +277091,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -273253,10 +277099,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -274366,8 +278209,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -274515,16 +278357,7 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "id" ] } ] @@ -274781,8 +278614,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -274964,10 +278796,7 @@ }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] + "type": "integer" }, "original_position": { "description": "The index of the original line in the diff to which the comment applies.", @@ -275181,8 +279010,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -275252,14 +279080,14 @@ "repository" ] }, - "webhook-pull-request-review-thread-unresolved": { - "title": "pull_request_review_thread unresolved event", + "webhook-pull-request-stacked": { + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unresolved" + "stacked" ] }, "enterprise": { @@ -275268,11 +279096,14 @@ "installation": { "$ref": "#/components/schemas/simple-installation" }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { - "title": "Simple Pull Request", + "title": "Pull Request", "type": "object", "properties": { "_links": { @@ -275407,6 +279238,9 @@ null ] }, + "additions": { + "type": "integer" + }, "assignee": { "title": "User", "type": [ @@ -275490,7 +279324,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -275591,7 +279426,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -275637,7 +279473,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -276050,6 +279889,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -276249,6 +280105,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -276304,6 +280177,11 @@ "type": "string", "format": "uri" }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, "visibility": { "type": "string", "enum": [ @@ -276519,35 +280397,53 @@ "null" ] }, + "changed_files": { + "type": "integer" + }, "closed_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" + }, + "comments": { + "type": "integer" }, "comments_url": { "type": "string", "format": "uri" }, + "commits": { + "type": "integer" + }, "commits_url": { "type": "string", "format": "uri" }, "created_at": { - "type": "string" + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" }, "diff_url": { "type": "string", "format": "uri" }, "draft": { + "description": "Indicates whether or not the pull request is a draft.", "type": "boolean" }, "head": { "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -276555,7 +280451,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -276838,6 +280737,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -277037,6 +280953,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -277092,6 +281025,11 @@ "type": "string", "format": "uri" }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, "visibility": { "type": "string", "enum": [ @@ -277361,16 +281299,136 @@ "locked": { "type": "boolean" }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, "merge_commit_sha": { "type": [ "string", "null" ] }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, "merged_at": { "type": [ "string", "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "milestone": { @@ -277478,7 +281536,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277572,12 +281631,19 @@ "type": "string" }, "number": { + "description": "Number uniquely identifying the pull request within its repository.", "type": "integer" }, "patch_url": { "type": "string", "format": "uri" }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, "requested_reviewers": { "type": "array", "items": { @@ -277665,7 +281731,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277813,7 +281880,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -277961,11 +282037,15 @@ "type": "string", "format": "uri-template" }, + "review_comments": { + "type": "integer" + }, "review_comments_url": { "type": "string", "format": "uri" }, "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", "enum": [ "open", @@ -277977,10 +282057,12 @@ "format": "uri" }, "title": { + "description": "The title of the pull request.", "type": "string" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "url": { "type": "string", @@ -278070,7 +282152,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -278112,7 +282195,6 @@ "requested_teams", "labels", "milestone", - "draft", "commits_url", "review_comments_url", "review_comment_url", @@ -278123,7 +282205,8 @@ "_links", "author_association", "auto_merge", - "active_lock_reason" + "active_lock_reason", + "draft" ] }, "repository": { @@ -278131,409 +282214,14 @@ }, "sender": { "$ref": "#/components/schemas/simple-user" - }, - "thread": { - "type": "object", - "properties": { - "comments": { - "type": "array", - "items": { - "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", - "type": "integer" - }, - "original_start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": "string", - "enum": [ - "LEFT", - "RIGHT" - ] - }, - "start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": [ - "string", - "null" - ], - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the pull request review comment", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links", - "start_line", - "original_start_line", - "original_line", - "line", - "start_side", - "side", - "reactions" - ] - } - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "node_id", - "comments" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } }, "required": [ "action", - "thread", + "number", "pull_request", - "repository" + "repository", + "sender" ] }, "webhook-pull-request-synchronize": { @@ -295418,18 +299106,263 @@ "sender" ] }, - "webhook-repository-vulnerability-alert-reopen": { - "title": "repository_vulnerability_alert reopen event", + "webhook-repository-vulnerability-alert-reopen": { + "title": "repository_vulnerability_alert reopen event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopen" + ] + }, + "alert": { + "$ref": "#/components/schemas/webhooks_alert" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-repository-vulnerability-alert-resolve": { + "title": "repository_vulnerability_alert resolve event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolve" + ] + }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "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" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "fixed", + "open" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopen" + "assigned" ] }, "alert": { - "$ref": "#/components/schemas/webhooks_alert" + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -295450,192 +299383,21 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] }, - "webhook-repository-vulnerability-alert-resolve": { - "title": "repository_vulnerability_alert resolve event", + "webhook-secret-scanning-alert-created": { + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "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" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] - } - } + "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -295656,32 +299418,28 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] }, - "webhook-secret-scanning-alert-assigned": { - "title": "secret_scanning_alert assigned event", + "webhook-secret-scanning-alert-location-created": { + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "assigned" + "created" ] }, "alert": { "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, - "assignee": { - "$ref": "#/components/schemas/simple-user" - }, - "enterprise": { - "$ref": "#/components/schemas/enterprise-webhooks" - }, "installation": { "$ref": "#/components/schemas/simple-installation" }, + "location": { + "$ref": "#/components/schemas/secret-scanning-location" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, @@ -295693,19 +299451,33 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" ] }, - "webhook-secret-scanning-alert-created": { - "title": "secret_scanning_alert created event", + "webhook-secret-scanning-alert-location-created-form-encoded": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "webhook-secret-scanning-alert-metadata-created": { + "title": "secret_scanning_alert metadata created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_created" ] }, "alert": { @@ -295733,25 +299505,25 @@ "repository" ] }, - "webhook-secret-scanning-alert-location-created": { - "title": "Secret Scanning Alert Location Created Event", + "webhook-secret-scanning-alert-metadata-removed": { + "title": "secret_scanning_alert metadata removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_removed" ] }, "alert": { "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "installation": { "$ref": "#/components/schemas/simple-installation" }, - "location": { - "$ref": "#/components/schemas/secret-scanning-location" - }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, @@ -295763,23 +299535,9 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "webhook-secret-scanning-alert-location-created-form-encoded": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] }, "webhook-secret-scanning-alert-publicly-leaked": { @@ -333825,7 +337583,13 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ] } }, "secret-scanning-alert-resolved": { @@ -333872,6 +337636,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -342048,6 +345818,24 @@ "type": "boolean" } }, + "secret-scanning-alert-included-metadata": { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-owner-email-hash": { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index d98160d6a2..f844aeb386 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 @@ -26742,6 +26742,8 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + - "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + - "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" responses: '200': description: Response @@ -53102,6 +53104,8 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + - "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + - "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" responses: '200': description: Response @@ -53150,7 +53154,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" examples: default: "$ref": "#/components/examples/secret-scanning-alert-open" @@ -53237,7 +53241,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" examples: default: "$ref": "#/components/examples/secret-scanning-alert-resolved" @@ -77294,6 +77298,72 @@ webhooks: - repository - organization - app + pull-request-stacked: + post: + summary: |- + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request was added to a stack. + operationId: pull-request/stacked + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: pull_request + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-pull-request-stacked" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app pull-request-synchronize: post: summary: |- @@ -79721,7 +79791,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-publicly-leaked: + secret-scanning-alert-metadata-created: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -79729,8 +79799,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was detected in a public repo. - operationId: secret-scanning-alert/publicly-leaked + description: Metadata was created for a secret scanning alert. + operationId: secret-scanning-alert/metadata-created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -79774,20 +79844,19 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - secret-scanning-alert-reopened: + secret-scanning-alert-metadata-removed: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -79795,8 +79864,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A previously closed secret scanning alert was reopened. - operationId: secret-scanning-alert/reopened + description: Metadata was removed from a secret scanning alert. + operationId: secret-scanning-alert/metadata-removed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -79840,20 +79909,19 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - secret-scanning-alert-resolved: + secret-scanning-alert-publicly-leaked: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -79861,8 +79929,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was closed. - operationId: secret-scanning-alert/resolved + description: A secret scanning alert was detected in a public repo. + operationId: secret-scanning-alert/publicly-leaked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -79906,7 +79974,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79919,7 +79987,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-unassigned: + secret-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -79927,8 +79995,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was unassigned. - operationId: secret-scanning-alert/unassigned + description: A previously closed secret scanning alert was reopened. + operationId: secret-scanning-alert/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -79972,7 +80040,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79985,7 +80053,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-validated: + secret-scanning-alert-resolved: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -79993,8 +80061,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was validated. - operationId: secret-scanning-alert/validated + description: A secret scanning alert was closed. + operationId: secret-scanning-alert/resolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -80038,7 +80106,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80051,19 +80119,18 @@ webhooks: - repository - organization - app - secret-scanning-scan-completed: + secret-scanning-alert-unassigned: post: summary: |- - This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates - to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning scan was completed. - operationId: secret-scanning-scan/completed + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -80077,7 +80144,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: secret_scanning_scan + example: secret_scanning_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80105,7 +80172,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80113,21 +80180,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_scan + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - security-advisory-published: + secret-scanning-alert-validated: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A security advisory was published to the GitHub community. - operationId: security-advisory/published + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was validated. + operationId: secret-scanning-alert/validated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -80141,7 +80210,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: security_advisory + example: secret_scanning_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80169,7 +80238,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80177,19 +80246,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: secret_scanning_alert supported-webhook-types: + - repository + - organization - app - security-advisory-updated: + secret-scanning-scan-completed: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: The metadata or description of a security advisory was changed. - operationId: security-advisory/updated + Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates + to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning scan was completed. + operationId: secret-scanning-scan/completed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan parameters: - name: User-Agent in: header @@ -80203,7 +80277,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: security_advisory + example: secret_scanning_scan schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80231,7 +80305,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80239,17 +80313,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: secret_scanning_scan supported-webhook-types: + - repository + - organization - app - security-advisory-withdrawn: + security-advisory-published: post: summary: |- This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A previously published security advisory was withdrawn. - operationId: security-advisory/withdrawn + description: A security advisory was published to the GitHub community. + operationId: security-advisory/published externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: @@ -80293,7 +80369,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80304,15 +80380,16 @@ webhooks: subcategory: security_advisory supported-webhook-types: - app - security-and-analysis: + security-advisory-updated: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: The metadata or description of a security advisory was changed. + operationId: security-advisory/updated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -80326,7 +80403,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: security_and_analysis + example: security_advisory schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80354,7 +80431,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80362,24 +80439,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_and_analysis + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sponsorship-cancelled: + security-advisory-withdrawn: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsorship was cancelled and the last billing cycle has ended. + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: A previously published security advisory was withdrawn. + operationId: security-advisory/withdrawn externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -80393,7 +80465,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sponsorship + example: security_advisory schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80421,7 +80493,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80429,20 +80501,18 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security_advisory supported-webhook-types: - - sponsors_listing - sponsorship-created: + - app + security-and-analysis: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor created a sponsorship for a sponsored account. This event - occurs once the payment is successfully processed. - operationId: sponsorship/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + operationId: security-and-analysis externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header @@ -80456,7 +80526,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sponsorship + example: security_and_analysis schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80484,7 +80554,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80492,19 +80562,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security_and_analysis supported-webhook-types: - - sponsors_listing - sponsorship-edited: + - repository + - organization + - app + sponsorship-cancelled: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A monthly sponsor changed who can see their sponsorship. If you - recognize your sponsors publicly, you may want to update your sponsor recognition - to reflect the change when this event occurs. - operationId: sponsorship/edited + description: |- + A sponsorship was cancelled and the last billing cycle has ended. + + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/cancelled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80548,7 +80621,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80559,17 +80632,15 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-cancellation: + sponsorship-created: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. - - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + description: A sponsor created a sponsorship for a sponsored account. This event + occurs once the payment is successfully processed. + operationId: sponsorship/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80613,7 +80684,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80624,15 +80695,16 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-tier-change: + sponsorship-edited: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor scheduled a downgrade to a lower sponsorship tier. The - new tier will become effective on their next billing date. - operationId: sponsorship/pending-tier-change + description: A monthly sponsor changed who can see their sponsorship. If you + recognize your sponsors publicly, you may want to update your sponsor recognition + to reflect the change when this event occurs. + operationId: sponsorship/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80676,7 +80748,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80687,17 +80759,17 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-tier-changed: + sponsorship-pending-cancellation: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor changed the tier of their sponsorship and the change - has taken effect. If a sponsor upgraded their tier, the change took effect - immediately. If a sponsor downgraded their tier, the change took effect at - the beginning of the sponsor's next billing cycle. - operationId: sponsorship/tier-changed + description: |- + A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/pending-cancellation externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80741,7 +80813,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80752,16 +80824,17 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - star-created: + sponsorship-pending-tier-change: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone starred a repository. - operationId: star/created + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor scheduled a downgrade to a lower sponsorship tier. The + new tier will become effective on their next billing date. + operationId: sponsorship/pending-tier-change externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -80775,7 +80848,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: star + example: sponsorship schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80803,7 +80876,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80811,21 +80884,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - star-deleted: + - sponsors_listing + sponsorship-tier-changed: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone unstarred the repository. - operationId: star/deleted + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor changed the tier of their sponsorship and the change + has taken effect. If a sponsor upgraded their tier, the change took effect + immediately. If a sponsor downgraded their tier, the change took effect at + the beginning of the sponsor's next billing cycle. + operationId: sponsorship/tier-changed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -80839,7 +80913,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: star + example: sponsorship schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80867,7 +80941,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80875,20 +80949,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - status: + - sponsors_listing + star-created: post: summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. - operationId: status + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone starred a repository. + operationId: star/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#status + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -80902,7 +80975,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: status + example: star schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80930,7 +81003,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80938,23 +81011,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: status + subcategory: star supported-webhook-types: - repository - organization - app - sub-issues-parent-issue-added: + star-deleted: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was added to an issue. - operationId: sub-issues/parent-issue-added + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone unstarred the repository. + operationId: star/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -80968,7 +81039,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sub_issues + example: star schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80996,7 +81067,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81004,23 +81075,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: star supported-webhook-types: - repository - organization - app - sub-issues-parent-issue-removed: + status: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was removed from an issue. - operationId: sub-issues/parent-issue-removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. + operationId: status externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header @@ -81034,7 +81102,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sub_issues + example: status schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81062,7 +81130,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81070,12 +81138,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: status supported-webhook-types: - repository - organization - app - sub-issues-sub-issue-added: + sub-issues-parent-issue-added: post: summary: |- This event occurs when there is activity relating to sub-issues. @@ -81083,8 +81151,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: A sub-issue was added to an issue. - operationId: sub-issues/sub-issue-added + description: A parent issue was added to an issue. + operationId: sub-issues/parent-issue-added externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: @@ -81128,7 +81196,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81141,7 +81209,7 @@ webhooks: - repository - organization - app - sub-issues-sub-issue-removed: + sub-issues-parent-issue-removed: post: summary: |- This event occurs when there is activity relating to sub-issues. @@ -81149,8 +81217,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: A sub-issue was removed from an issue. - operationId: sub-issues/sub-issue-removed + description: A parent issue was removed from an issue. + operationId: sub-issues/parent-issue-removed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: @@ -81194,7 +81262,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81207,18 +81275,18 @@ webhooks: - repository - organization - app - team-add: + sub-issues-sub-issue-added: post: summary: |- - This event occurs when a team is added to a repository. - For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + This event occurs when there is activity relating to sub-issues. - For activity relating to teams, see the `teams` 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 "Members" organization permission. - operationId: team-add + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was added to an issue. + operationId: sub-issues/sub-issue-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -81232,7 +81300,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: team_add + example: sub_issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81260,7 +81328,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81268,87 +81336,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team_add + subcategory: sub-issues supported-webhook-types: - repository - organization - app - team-added-to-repository: + sub-issues-sub-issue-removed: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was granted access to a repository. - operationId: team/added-to-repository - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: team - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-team-added-to-repository" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: team - supported-webhook-types: - - organization - - business - - app - team-created: - post: - summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + 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 "Members" organization permission. - description: A team was created. - operationId: team/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was removed from an issue. + operationId: sub-issues/sub-issue-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -81362,7 +81366,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: team + example: sub_issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81390,7 +81394,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81398,22 +81402,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sub-issues supported-webhook-types: + - repository - organization - - business - app - team-deleted: + team-add: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when a team is added to a repository. + For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + + For activity relating to teams, see the `teams` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was deleted. - operationId: team/deleted + operationId: team-add externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add parameters: - name: User-Agent in: header @@ -81427,7 +81432,202 @@ webhooks: type: string - name: X-Github-Event in: header - example: team + example: team_add + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-add" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team_add + supported-webhook-types: + - repository + - organization + - app + team-added-to-repository: + post: + summary: |- + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was granted access to a repository. + operationId: team/added-to-repository + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: team + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-added-to-repository" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team + supported-webhook-types: + - organization + - business + - app + team-created: + post: + summary: |- + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was created. + operationId: team/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: team + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team + supported-webhook-types: + - organization + - business + - app + team-deleted: + post: + summary: |- + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was deleted. + operationId: team/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: team schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -97047,6 +97247,8 @@ components: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" require_code_owner_review: type: boolean description: Require an approving review in pull requests that modify @@ -111018,6 +111220,172 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + secret-scanning-alert-metadata: + type: array + description: A list of metadata key/value pairs associated with the secret scanning + alert. + readOnly: true + items: + type: object + properties: + key: + type: string + description: The metadata key. + value: + type: string + description: The metadata value. + required: + - key + - value + secret-scanning-alert-with-metadata: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + "$ref": "#/components/schemas/secret-scanning-alert-state" + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + provider: + type: + - string + - 'null' + description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. Use this value for filtering by provider with the `providers` + or `exclude_providers` parameters. + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the detected secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple repositories + under the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert is base64 + encoded + first_location_detected: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/secret-scanning-first-detected-location" + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token in the + alert was detected in more than one location. + assigned_to: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + closure_request_comment: + type: + - string + - 'null' + description: An optional comment from the closure request author. + closure_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment from the closure request reviewer. + closure_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + metadata: + "$ref": "#/components/schemas/secret-scanning-alert-metadata" secret-scanning-alert-resolution-comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -123280,6 +123648,8 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + metadata: + "$ref": "#/components/schemas/secret-scanning-alert-metadata" webhooks_security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -197187,53 +197557,2323 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: - "$ref": "#/components/schemas/simple-user" - required: - - requested_team - - action - - number - - pull_request - - repository - - sender - webhook-pull-request-review-submitted: - title: pull_request_review submitted event + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: + "$ref": "#/components/schemas/simple-user" + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-review-submitted: + title: pull_request_review submitted event + type: object + properties: + action: + type: string + enum: + - submitted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments_url: + type: string + format: uri + commits_url: + type: string + format: uri + created_at: + type: string + diff_url: + type: string + format: uri + draft: + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merge_commit_sha: + type: + - string + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: + "$ref": "#/components/schemas/repository-webhooks" + review: + "$ref": "#/components/schemas/webhooks_review" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - review + - pull_request + - repository + - sender + webhook-pull-request-review-thread-resolved: + title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - - submitted + - resolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -197401,7 +200041,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -197475,7 +200114,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -197815,28 +200453,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -197976,28 +200592,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -198038,12 +200632,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property is closing down. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -198459,28 +201047,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -198620,28 +201186,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -198682,12 +201226,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property is closing down. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -198991,7 +201529,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -199486,24 +202023,331 @@ components: - active_lock_reason repository: "$ref": "#/components/schemas/repository-webhooks" - review: - "$ref": "#/components/schemas/webhooks_review" sender: "$ref": "#/components/schemas/simple-user" + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment + applies. + type: string + original_line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff to which + the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the comment + applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review comment + belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be + a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - - review + - thread - pull_request - repository - - sender - webhook-pull-request-review-thread-resolved: - title: pull_request_review_thread resolved event + webhook-pull-request-review-thread-unresolved: + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - resolved + - unresolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -199777,9 +202621,7 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -200457,17 +203299,13 @@ components: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -201296,7 +204134,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -201407,15 +204244,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -201605,7 +204433,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -201751,9 +204578,7 @@ components: original_line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment - type: - - integer - - 'null' + type: integer original_position: description: The index of the original line in the diff to which the comment applies. @@ -201920,7 +204745,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -201970,22 +204794,24 @@ components: - thread - pull_request - repository - webhook-pull-request-review-thread-unresolved: - title: pull_request_review_thread unresolved event + webhook-pull-request-stacked: + title: pull_request stacked event type: object properties: action: type: string enum: - - unresolved + - stacked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Simple Pull Request + title: Pull Request type: object properties: _links: @@ -202082,6 +204908,8 @@ components: - too heated - spam - + additions: + type: integer assignee: title: User type: @@ -202145,6 +204973,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -202218,6 +205047,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -202251,7 +205081,9 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -202555,6 +205387,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -202694,6 +205548,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -202734,6 +205610,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -202908,34 +205790,49 @@ components: type: - string - 'null' + changed_files: + type: integer closed_at: type: - string - 'null' + format: date-time + comments: + type: integer comments_url: type: string format: uri + commits: + type: integer commits_url: type: string format: uri created_at: type: string + format: date-time + deletions: + type: integer diff_url: type: string format: uri draft: + description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -203145,6 +206042,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -203284,6 +206203,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -203324,6 +206265,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -203539,14 +206486,100 @@ components: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean merge_commit_sha: type: - string - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' merged_at: type: - string - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -203627,6 +206660,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203694,10 +206728,16 @@ components: node_id: type: string number: + description: Number uniquely identifying the pull request within its + repository. type: integer patch_url: type: string format: uri + rebaseable: + type: + - boolean + - 'null' requested_reviewers: type: array items: @@ -203764,6 +206804,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203874,6 +206915,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -203981,10 +207031,13 @@ components: review_comment_url: type: string format: uri-template + review_comments: + type: integer review_comments_url: type: string format: uri state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -203993,9 +207046,11 @@ components: type: string format: uri title: + description: The title of the pull request. type: string updated_at: type: string + format: date-time url: type: string format: uri @@ -204063,6 +207118,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -204096,7 +207152,6 @@ components: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -204108,322 +207163,17 @@ components: - author_association - auto_merge - active_lock_reason + - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. - type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the comment - applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review comment - belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be - a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: - - string - - 'null' - format: date-time required: - action - - thread + - number - pull_request - repository + - sender webhook-pull-request-synchronize: title: pull_request synchronize event type: object @@ -217248,6 +219998,54 @@ components: type: string required: - payload + webhook-secret-scanning-alert-metadata-created: + title: secret_scanning_alert metadata created event + type: object + properties: + action: + type: string + enum: + - metadata_created + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository + webhook-secret-scanning-alert-metadata-removed: + title: secret_scanning_alert metadata removed event + type: object + properties: + action: + type: string + enum: + - metadata_removed + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-publicly-leaked: title: secret_scanning_alert publicly leaked event type: object @@ -248800,6 +251598,9 @@ components: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com secret-scanning-alert-resolved: value: number: 42 @@ -248843,6 +251644,9 @@ components: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -255982,6 +258786,29 @@ components: required: false schema: type: boolean + secret-scanning-alert-included-metadata: + name: included_metadata + in: query + description: |- + A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the + specified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`, + `owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`, + `organization-id`, `last-used-date`, and `has-organization-access`. + required: false + schema: + type: string + secret-scanning-alert-owner-email-hash: + name: owner_email_hash + in: query + description: |- + Filters alerts to only those whose attached `owner_email` metadata field matches the + provided value. The value must be the lowercase hex-encoded SHA-256 hash of the email + address to match (for example, the SHA-256 of `user@example.com`). Only alerts that + have an `owner_email` metadata value whose SHA-256 hash equals this parameter are + returned. + required: false + schema: + type: string network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index 075af3fc59..1298f15ece 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -36291,6 +36291,12 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" } ], "responses": { @@ -72489,6 +72495,12 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" } ], "responses": { @@ -72557,7 +72569,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -72685,7 +72697,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -106240,6 +106252,99 @@ } } }, + "pull-request-stacked": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-stacked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", @@ -109696,11 +109801,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-metadata-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "Metadata was created for a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -109767,7 +109872,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-created" } } } @@ -109778,7 +109883,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -109789,11 +109893,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-metadata-removed": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "Metadata was removed from a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -109860,7 +109964,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-removed" } } } @@ -109871,7 +109975,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -109882,11 +109985,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-publicly-leaked": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -109953,7 +110056,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -109975,11 +110078,11 @@ } } }, - "secret-scanning-alert-unassigned": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was unassigned.", - "operationId": "secret-scanning-alert/unassigned", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110046,7 +110149,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -110068,11 +110171,11 @@ } } }, - "secret-scanning-alert-validated": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was validated.", - "operationId": "secret-scanning-alert/validated", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110139,7 +110242,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -110161,13 +110264,13 @@ } } }, - "secret-scanning-scan-completed": { + "secret-scanning-alert-unassigned": { "post": { - "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning scan was completed.", - "operationId": "secret-scanning-scan/completed", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110189,7 +110292,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_scan", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110232,7 +110335,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -110245,7 +110348,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_scan", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -110254,13 +110357,13 @@ } } }, - "security-advisory-published": { + "secret-scanning-alert-validated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A security advisory was published to the GitHub community.", - "operationId": "security-advisory/published", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110282,7 +110385,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110325,7 +110428,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -110338,20 +110441,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-updated": { + "secret-scanning-scan-completed": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed.", - "operationId": "security-advisory/updated", + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning scan was completed.", + "operationId": "secret-scanning-scan/completed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" }, "parameters": [ { @@ -110373,7 +110478,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_scan", "schema": { "type": "string" } @@ -110416,7 +110521,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -110429,18 +110534,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_scan", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-withdrawn": { + "security-advisory-published": { "post": { "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A previously published security advisory was withdrawn.", - "operationId": "security-advisory/withdrawn", + "description": "A security advisory was published to the GitHub community.", + "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, @@ -110507,7 +110614,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -110527,12 +110634,13 @@ } } }, - "security-and-analysis": { + "security-advisory-updated": { "post": { - "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "operationId": "security-and-analysis", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -110554,7 +110662,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_and_analysis", + "example": "security_advisory", "schema": { "type": "string" } @@ -110597,7 +110705,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -110610,22 +110718,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "security_advisory", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "sponsorship-cancelled": { + "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/cancelled", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -110647,7 +110753,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_advisory", "schema": { "type": "string" } @@ -110690,7 +110796,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -110703,20 +110809,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_advisory", "supported-webhook-types": [ - "sponsors_listing" + "app" ] } } }, - "sponsorship-created": { + "security-and-analysis": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", - "operationId": "sponsorship/created", + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "operationId": "security-and-analysis", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -110738,7 +110843,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_and_analysis", "schema": { "type": "string" } @@ -110781,7 +110886,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -110794,18 +110899,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_and_analysis", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "sponsorship-edited": { + "sponsorship-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", - "operationId": "sponsorship/edited", + "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -110872,7 +110979,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -110892,11 +110999,11 @@ } } }, - "sponsorship-pending-cancellation": { + "sponsorship-created": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/pending-cancellation", + "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", + "operationId": "sponsorship/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -110963,7 +111070,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -110983,11 +111090,11 @@ } } }, - "sponsorship-pending-tier-change": { + "sponsorship-edited": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", - "operationId": "sponsorship/pending-tier-change", + "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", + "operationId": "sponsorship/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111054,7 +111161,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -111074,11 +111181,11 @@ } } }, - "sponsorship-tier-changed": { + "sponsorship-pending-cancellation": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", - "operationId": "sponsorship/tier-changed", + "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/pending-cancellation", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111145,7 +111252,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -111165,13 +111272,13 @@ } } }, - "star-created": { + "sponsorship-pending-tier-change": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone starred a repository.", - "operationId": "star/created", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", + "operationId": "sponsorship/pending-tier-change", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111193,7 +111300,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111236,7 +111343,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -111249,22 +111356,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "star-deleted": { + "sponsorship-tier-changed": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone unstarred the repository.", - "operationId": "star/deleted", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", + "operationId": "sponsorship/tier-changed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111286,7 +111391,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111329,7 +111434,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -111342,21 +111447,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "status": { + "star-created": { "post": { - "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", - "operationId": "status", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone starred a repository.", + "operationId": "star/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -111378,7 +111482,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "status", + "example": "star", "schema": { "type": "string" } @@ -111421,7 +111525,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -111434,7 +111538,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111443,13 +111547,13 @@ } } }, - "sub-issues-parent-issue-added": { + "star-deleted": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was added to an issue.", - "operationId": "sub-issues/parent-issue-added", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone unstarred the repository.", + "operationId": "star/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -111471,7 +111575,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "star", "schema": { "type": "string" } @@ -111514,7 +111618,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -111527,7 +111631,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111536,13 +111640,12 @@ } } }, - "sub-issues-parent-issue-removed": { + "status": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was removed from an issue.", - "operationId": "sub-issues/parent-issue-removed", + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "operationId": "status", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -111564,7 +111667,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "status", "schema": { "type": "string" } @@ -111607,7 +111710,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" } } } @@ -111620,7 +111723,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "status", "supported-webhook-types": [ "repository", "organization", @@ -111629,11 +111732,11 @@ } } }, - "sub-issues-sub-issue-added": { + "sub-issues-parent-issue-added": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was added to an issue.", - "operationId": "sub-issues/sub-issue-added", + "description": "A parent issue was added to an issue.", + "operationId": "sub-issues/parent-issue-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -111700,7 +111803,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -111722,11 +111825,11 @@ } } }, - "sub-issues-sub-issue-removed": { + "sub-issues-parent-issue-removed": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was removed from an issue.", - "operationId": "sub-issues/sub-issue-removed", + "description": "A parent issue was removed from an issue.", + "operationId": "sub-issues/parent-issue-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -111793,7 +111896,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -111815,12 +111918,13 @@ } } }, - "team-add": { + "sub-issues-sub-issue-added": { "post": { - "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "operationId": "team-add", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was added to an issue.", + "operationId": "sub-issues/sub-issue-added", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -111842,7 +111946,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team_add", + "example": "sub_issues", "schema": { "type": "string" } @@ -111885,7 +111989,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -111898,7 +112002,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "sub-issues", "supported-webhook-types": [ "repository", "organization", @@ -111907,13 +112011,13 @@ } } }, - "team-added-to-repository": { + "sub-issues-sub-issue-removed": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was granted access to a repository.", - "operationId": "team/added-to-repository", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was removed from an issue.", + "operationId": "sub-issues/sub-issue-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -111935,7 +112039,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "sub_issues", "schema": { "type": "string" } @@ -111978,7 +112082,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -111991,22 +112095,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "sub-issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-created": { + "team-add": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was created.", - "operationId": "team/created", + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "operationId": "team-add", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -112028,7 +112131,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "team_add", "schema": { "type": "string" } @@ -112071,7 +112174,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -112084,20 +112187,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "team_add", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-deleted": { + "team-added-to-repository": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was deleted.", - "operationId": "team/deleted", + "description": "A team was granted access to a repository.", + "operationId": "team/added-to-repository", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112164,7 +112267,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -112186,11 +112289,11 @@ } } }, - "team-edited": { + "team-created": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name, description, or visibility of a team was changed.", - "operationId": "team/edited", + "description": "A team was created.", + "operationId": "team/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112257,7 +112360,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -112279,11 +112382,11 @@ } } }, - "team-removed-from-repository": { + "team-deleted": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team's access to a repository was removed.", - "operationId": "team/removed-from-repository", + "description": "A team was deleted.", + "operationId": "team/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112350,7 +112453,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-deleted" } } } @@ -112372,13 +112475,13 @@ } } }, - "watch-started": { + "team-edited": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone started watching the repository.", - "operationId": "watch/started", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name, description, or visibility of a team was changed.", + "operationId": "team/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -112400,7 +112503,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "watch", + "example": "team", "schema": { "type": "string" } @@ -112443,7 +112546,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-edited" } } } @@ -112456,21 +112559,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "watch", + "subcategory": "team", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "workflow-dispatch": { + "team-removed-from-repository": { "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "workflow-dispatch", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team's access to a repository was removed.", + "operationId": "team/removed-from-repository", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -112492,7 +112596,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_dispatch", + "example": "team", "schema": { "type": "string" } @@ -112535,7 +112639,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" } } } @@ -112548,20 +112652,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_dispatch", + "subcategory": "team", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "workflow-job-completed": { + "watch-started": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", - "operationId": "workflow-job/completed", + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone started watching the repository.", + "operationId": "watch/started", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" }, "parameters": [ { @@ -112583,7 +112689,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "watch", "schema": { "type": "string" } @@ -112626,7 +112732,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-watch-started" } } } @@ -112639,9 +112745,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "watch", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -112649,13 +112754,12 @@ } } }, - "workflow-job-in-progress": { + "workflow-dispatch": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run started processing on a runner.", - "operationId": "workflow-job/in-progress", + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "workflow-dispatch", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" }, "parameters": [ { @@ -112677,7 +112781,192 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "workflow_dispatch", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-dispatch" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "workflow-job-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", + "operationId": "workflow-job/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_job", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run started processing on a runner.", + "operationId": "workflow-job/in-progress", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_job", "schema": { "type": "string" } @@ -132492,6 +132781,9 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -152106,6 +152398,255 @@ } } }, + "secret-scanning-alert-metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } + }, + "secret-scanning-alert-with-metadata": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/alert-updated-at" + } + ] + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise." + }, + "is_base64_encoded": { + "type": [ + "boolean", + "null" + ], + "description": "A boolean value representing whether or not alert is base64 encoded" + }, + "first_location_detected": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/secret-scanning-first-detected-location" + } + ] + }, + "has_more_locations": { + "type": "boolean", + "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "metadata": { + "$ref": "#/components/schemas/secret-scanning-alert-metadata" + } + } + }, "secret-scanning-alert-resolution-comment": { "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": [ @@ -168876,6 +169417,9 @@ "$ref": "#/components/schemas/simple-user" } ] + }, + "metadata": { + "$ref": "#/components/schemas/secret-scanning-alert-metadata" } } }, @@ -268576,8 +269120,2982 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": [ + "string", + "null" + ] + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merged_at": { + "type": [ + "string", + "null" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "review": { + "$ref": "#/components/schemas/webhooks_review" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "review", + "pull_request", + "repository", + "sender" + ] + }, + "webhook-pull-request-review-thread-resolved": { + "title": "pull_request_review_thread resolved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolved" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Simple Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, "url": { @@ -269039,23 +272557,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -269255,23 +272756,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -269867,23 +273351,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -270083,23 +273550,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -270535,8 +273985,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -271197,29 +274646,425 @@ "repository": { "$ref": "#/components/schemas/repository-webhooks" }, - "review": { - "$ref": "#/components/schemas/webhooks_review" - }, "sender": { "$ref": "#/components/schemas/simple-user" + }, + "thread": { + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "title": "Pull Request Review Comment", + "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "type": "string" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies.", + "type": "integer" + }, + "original_start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "enum": [ + "LEFT", + "RIGHT" + ] + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": [ + "string", + "null" + ], + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the pull request review comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links", + "start_line", + "original_start_line", + "original_line", + "line", + "start_side", + "side", + "reactions" + ] + } + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "node_id", + "comments" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ "action", - "review", + "thread", "pull_request", - "repository", - "sender" + "repository" ] }, - "webhook-pull-request-review-thread-resolved": { - "title": "pull_request_review_thread resolved event", + "webhook-pull-request-review-thread-unresolved": { + "title": "pull_request_review_thread unresolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unresolved" ] }, "enterprise": { @@ -271597,10 +275442,7 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": [ - "string", - "null" - ] + "type": "string" }, "enabled_by": { "title": "User", @@ -272510,10 +276352,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -272521,10 +276360,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -273628,8 +277464,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -273777,16 +277612,7 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "id" ] } ] @@ -274043,8 +277869,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -274225,10 +278050,7 @@ }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] + "type": "integer" }, "original_position": { "description": "The index of the original line in the diff to which the comment applies.", @@ -274442,8 +278264,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -274513,14 +278334,14 @@ "repository" ] }, - "webhook-pull-request-review-thread-unresolved": { - "title": "pull_request_review_thread unresolved event", + "webhook-pull-request-stacked": { + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unresolved" + "stacked" ] }, "enterprise": { @@ -274529,11 +278350,14 @@ "installation": { "$ref": "#/components/schemas/simple-installation" }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { - "title": "Simple Pull Request", + "title": "Pull Request", "type": "object", "properties": { "_links": { @@ -274668,6 +278492,9 @@ null ] }, + "additions": { + "type": "integer" + }, "assignee": { "title": "User", "type": [ @@ -274751,7 +278578,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -274852,7 +278680,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -274898,7 +278727,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -275311,6 +279143,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -275510,6 +279359,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -275780,35 +279646,53 @@ "null" ] }, + "changed_files": { + "type": "integer" + }, "closed_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" + }, + "comments": { + "type": "integer" }, "comments_url": { "type": "string", "format": "uri" }, + "commits": { + "type": "integer" + }, "commits_url": { "type": "string", "format": "uri" }, "created_at": { - "type": "string" + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" }, "diff_url": { "type": "string", "format": "uri" }, "draft": { + "description": "Indicates whether or not the pull request is a draft.", "type": "boolean" }, "head": { "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -275816,7 +279700,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -276099,6 +279986,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -276298,6 +280202,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -276622,10 +280543,130 @@ "locked": { "type": "boolean" }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, "merged_at": { "type": [ "string", "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "milestone": { @@ -276733,7 +280774,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -276827,12 +280869,19 @@ "type": "string" }, "number": { + "description": "Number uniquely identifying the pull request within its repository.", "type": "integer" }, "patch_url": { "type": "string", "format": "uri" }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, "requested_reviewers": { "type": "array", "items": { @@ -276920,7 +280969,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277068,7 +281118,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -277216,11 +281275,15 @@ "type": "string", "format": "uri-template" }, + "review_comments": { + "type": "integer" + }, "review_comments_url": { "type": "string", "format": "uri" }, "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", "enum": [ "open", @@ -277232,10 +281295,12 @@ "format": "uri" }, "title": { + "description": "The title of the pull request.", "type": "string" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "url": { "type": "string", @@ -277325,7 +281390,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277366,7 +281432,6 @@ "requested_teams", "labels", "milestone", - "draft", "commits_url", "review_comments_url", "review_comment_url", @@ -277377,7 +281442,8 @@ "_links", "author_association", "auto_merge", - "active_lock_reason" + "active_lock_reason", + "draft" ] }, "repository": { @@ -277385,409 +281451,14 @@ }, "sender": { "$ref": "#/components/schemas/simple-user" - }, - "thread": { - "type": "object", - "properties": { - "comments": { - "type": "array", - "items": { - "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", - "type": "integer" - }, - "original_start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": "string", - "enum": [ - "LEFT", - "RIGHT" - ] - }, - "start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": [ - "string", - "null" - ], - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the pull request review comment", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links", - "start_line", - "original_start_line", - "original_line", - "line", - "start_side", - "side", - "reactions" - ] - } - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "node_id", - "comments" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } }, "required": [ "action", - "thread", + "number", "pull_request", - "repository" + "repository", + "sender" ] }, "webhook-pull-request-synchronize": { @@ -294604,18 +298275,263 @@ "sender" ] }, - "webhook-repository-vulnerability-alert-reopen": { - "title": "repository_vulnerability_alert reopen event", + "webhook-repository-vulnerability-alert-reopen": { + "title": "repository_vulnerability_alert reopen event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopen" + ] + }, + "alert": { + "$ref": "#/components/schemas/webhooks_alert" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-repository-vulnerability-alert-resolve": { + "title": "repository_vulnerability_alert resolve event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolve" + ] + }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "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" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "fixed", + "open" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopen" + "assigned" ] }, "alert": { - "$ref": "#/components/schemas/webhooks_alert" + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -294636,192 +298552,21 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] }, - "webhook-repository-vulnerability-alert-resolve": { - "title": "repository_vulnerability_alert resolve event", + "webhook-secret-scanning-alert-created": { + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "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" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] - } - } + "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -294842,32 +298587,28 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] }, - "webhook-secret-scanning-alert-assigned": { - "title": "secret_scanning_alert assigned event", + "webhook-secret-scanning-alert-location-created": { + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "assigned" + "created" ] }, "alert": { "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, - "assignee": { - "$ref": "#/components/schemas/simple-user" - }, - "enterprise": { - "$ref": "#/components/schemas/enterprise-webhooks" - }, "installation": { "$ref": "#/components/schemas/simple-installation" }, + "location": { + "$ref": "#/components/schemas/secret-scanning-location" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, @@ -294879,19 +298620,33 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" ] }, - "webhook-secret-scanning-alert-created": { - "title": "secret_scanning_alert created event", + "webhook-secret-scanning-alert-location-created-form-encoded": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "webhook-secret-scanning-alert-metadata-created": { + "title": "secret_scanning_alert metadata created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_created" ] }, "alert": { @@ -294919,25 +298674,25 @@ "repository" ] }, - "webhook-secret-scanning-alert-location-created": { - "title": "Secret Scanning Alert Location Created Event", + "webhook-secret-scanning-alert-metadata-removed": { + "title": "secret_scanning_alert metadata removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_removed" ] }, "alert": { "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "installation": { "$ref": "#/components/schemas/simple-installation" }, - "location": { - "$ref": "#/components/schemas/secret-scanning-location" - }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, @@ -294949,23 +298704,9 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "webhook-secret-scanning-alert-location-created-form-encoded": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] }, "webhook-secret-scanning-alert-publicly-leaked": { @@ -332893,7 +336634,13 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ] } }, "secret-scanning-alert-resolved": { @@ -332940,6 +336687,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -341108,6 +344861,24 @@ "type": "boolean" } }, + "secret-scanning-alert-included-metadata": { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-owner-email-hash": { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index a847daae31..25563b5065 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -26712,6 +26712,8 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + - "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + - "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" responses: '200': description: Response @@ -53027,6 +53029,8 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + - "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + - "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" responses: '200': description: Response @@ -53075,7 +53079,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" examples: default: "$ref": "#/components/examples/secret-scanning-alert-open" @@ -53162,7 +53166,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" examples: default: "$ref": "#/components/examples/secret-scanning-alert-resolved" @@ -77193,6 +77197,72 @@ webhooks: - repository - organization - app + pull-request-stacked: + post: + summary: |- + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request was added to a stack. + operationId: pull-request/stacked + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: pull_request + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-pull-request-stacked" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app pull-request-synchronize: post: summary: |- @@ -79620,7 +79690,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-publicly-leaked: + secret-scanning-alert-metadata-created: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -79628,8 +79698,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was detected in a public repo. - operationId: secret-scanning-alert/publicly-leaked + description: Metadata was created for a secret scanning alert. + operationId: secret-scanning-alert/metadata-created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -79673,20 +79743,19 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - secret-scanning-alert-reopened: + secret-scanning-alert-metadata-removed: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -79694,8 +79763,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A previously closed secret scanning alert was reopened. - operationId: secret-scanning-alert/reopened + description: Metadata was removed from a secret scanning alert. + operationId: secret-scanning-alert/metadata-removed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -79739,20 +79808,19 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - secret-scanning-alert-resolved: + secret-scanning-alert-publicly-leaked: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -79760,8 +79828,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was closed. - operationId: secret-scanning-alert/resolved + description: A secret scanning alert was detected in a public repo. + operationId: secret-scanning-alert/publicly-leaked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -79805,7 +79873,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79818,7 +79886,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-unassigned: + secret-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -79826,8 +79894,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was unassigned. - operationId: secret-scanning-alert/unassigned + description: A previously closed secret scanning alert was reopened. + operationId: secret-scanning-alert/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -79871,7 +79939,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79884,7 +79952,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-validated: + secret-scanning-alert-resolved: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -79892,8 +79960,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was validated. - operationId: secret-scanning-alert/validated + description: A secret scanning alert was closed. + operationId: secret-scanning-alert/resolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -79937,7 +80005,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79950,19 +80018,18 @@ webhooks: - repository - organization - app - secret-scanning-scan-completed: + secret-scanning-alert-unassigned: post: summary: |- - This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates - to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning scan was completed. - operationId: secret-scanning-scan/completed + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -79976,7 +80043,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: secret_scanning_scan + example: secret_scanning_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80004,7 +80071,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80012,21 +80079,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_scan + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - security-advisory-published: + secret-scanning-alert-validated: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A security advisory was published to the GitHub community. - operationId: security-advisory/published + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was validated. + operationId: secret-scanning-alert/validated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -80040,7 +80109,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: security_advisory + example: secret_scanning_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80068,7 +80137,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80076,19 +80145,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: secret_scanning_alert supported-webhook-types: + - repository + - organization - app - security-advisory-updated: + secret-scanning-scan-completed: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: The metadata or description of a security advisory was changed. - operationId: security-advisory/updated + Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates + to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning scan was completed. + operationId: secret-scanning-scan/completed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan parameters: - name: User-Agent in: header @@ -80102,7 +80176,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: security_advisory + example: secret_scanning_scan schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80130,7 +80204,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80138,17 +80212,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: secret_scanning_scan supported-webhook-types: + - repository + - organization - app - security-advisory-withdrawn: + security-advisory-published: post: summary: |- This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A previously published security advisory was withdrawn. - operationId: security-advisory/withdrawn + description: A security advisory was published to the GitHub community. + operationId: security-advisory/published externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: @@ -80192,7 +80268,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80203,15 +80279,16 @@ webhooks: subcategory: security_advisory supported-webhook-types: - app - security-and-analysis: + security-advisory-updated: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: The metadata or description of a security advisory was changed. + operationId: security-advisory/updated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -80225,7 +80302,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: security_and_analysis + example: security_advisory schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80253,7 +80330,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80261,24 +80338,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_and_analysis + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sponsorship-cancelled: + security-advisory-withdrawn: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsorship was cancelled and the last billing cycle has ended. + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: A previously published security advisory was withdrawn. + operationId: security-advisory/withdrawn externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -80292,7 +80364,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sponsorship + example: security_advisory schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80320,7 +80392,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80328,20 +80400,18 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security_advisory supported-webhook-types: - - sponsors_listing - sponsorship-created: + - app + security-and-analysis: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor created a sponsorship for a sponsored account. This event - occurs once the payment is successfully processed. - operationId: sponsorship/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + operationId: security-and-analysis externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header @@ -80355,7 +80425,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sponsorship + example: security_and_analysis schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80383,7 +80453,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80391,19 +80461,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security_and_analysis supported-webhook-types: - - sponsors_listing - sponsorship-edited: + - repository + - organization + - app + sponsorship-cancelled: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A monthly sponsor changed who can see their sponsorship. If you - recognize your sponsors publicly, you may want to update your sponsor recognition - to reflect the change when this event occurs. - operationId: sponsorship/edited + description: |- + A sponsorship was cancelled and the last billing cycle has ended. + + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/cancelled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80447,7 +80520,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80458,17 +80531,15 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-cancellation: + sponsorship-created: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. - - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + description: A sponsor created a sponsorship for a sponsored account. This event + occurs once the payment is successfully processed. + operationId: sponsorship/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80512,7 +80583,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80523,15 +80594,16 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-tier-change: + sponsorship-edited: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor scheduled a downgrade to a lower sponsorship tier. The - new tier will become effective on their next billing date. - operationId: sponsorship/pending-tier-change + description: A monthly sponsor changed who can see their sponsorship. If you + recognize your sponsors publicly, you may want to update your sponsor recognition + to reflect the change when this event occurs. + operationId: sponsorship/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80575,7 +80647,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80586,17 +80658,17 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-tier-changed: + sponsorship-pending-cancellation: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor changed the tier of their sponsorship and the change - has taken effect. If a sponsor upgraded their tier, the change took effect - immediately. If a sponsor downgraded their tier, the change took effect at - the beginning of the sponsor's next billing cycle. - operationId: sponsorship/tier-changed + description: |- + A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/pending-cancellation externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80640,7 +80712,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80651,16 +80723,17 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - star-created: + sponsorship-pending-tier-change: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone starred a repository. - operationId: star/created + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor scheduled a downgrade to a lower sponsorship tier. The + new tier will become effective on their next billing date. + operationId: sponsorship/pending-tier-change externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -80674,7 +80747,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: star + example: sponsorship schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80702,7 +80775,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80710,21 +80783,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - star-deleted: + - sponsors_listing + sponsorship-tier-changed: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone unstarred the repository. - operationId: star/deleted + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor changed the tier of their sponsorship and the change + has taken effect. If a sponsor upgraded their tier, the change took effect + immediately. If a sponsor downgraded their tier, the change took effect at + the beginning of the sponsor's next billing cycle. + operationId: sponsorship/tier-changed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -80738,7 +80812,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: star + example: sponsorship schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80766,7 +80840,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80774,20 +80848,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - status: + - sponsors_listing + star-created: post: summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. - operationId: status + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone starred a repository. + operationId: star/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#status + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -80801,7 +80874,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: status + example: star schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80829,7 +80902,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80837,23 +80910,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: status + subcategory: star supported-webhook-types: - repository - organization - app - sub-issues-parent-issue-added: + star-deleted: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was added to an issue. - operationId: sub-issues/parent-issue-added + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone unstarred the repository. + operationId: star/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -80867,7 +80938,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sub_issues + example: star schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80895,7 +80966,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80903,23 +80974,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: star supported-webhook-types: - repository - organization - app - sub-issues-parent-issue-removed: + status: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was removed from an issue. - operationId: sub-issues/parent-issue-removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. + operationId: status externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header @@ -80933,7 +81001,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sub_issues + example: status schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80961,7 +81029,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80969,12 +81037,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: status supported-webhook-types: - repository - organization - app - sub-issues-sub-issue-added: + sub-issues-parent-issue-added: post: summary: |- This event occurs when there is activity relating to sub-issues. @@ -80982,8 +81050,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: A sub-issue was added to an issue. - operationId: sub-issues/sub-issue-added + description: A parent issue was added to an issue. + operationId: sub-issues/parent-issue-added externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: @@ -81027,7 +81095,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81040,7 +81108,7 @@ webhooks: - repository - organization - app - sub-issues-sub-issue-removed: + sub-issues-parent-issue-removed: post: summary: |- This event occurs when there is activity relating to sub-issues. @@ -81048,8 +81116,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: A sub-issue was removed from an issue. - operationId: sub-issues/sub-issue-removed + description: A parent issue was removed from an issue. + operationId: sub-issues/parent-issue-removed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: @@ -81093,7 +81161,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81106,18 +81174,18 @@ webhooks: - repository - organization - app - team-add: + sub-issues-sub-issue-added: post: summary: |- - This event occurs when a team is added to a repository. - For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + This event occurs when there is activity relating to sub-issues. - For activity relating to teams, see the `teams` 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 "Members" organization permission. - operationId: team-add + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was added to an issue. + operationId: sub-issues/sub-issue-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -81131,7 +81199,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: team_add + example: sub_issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81159,7 +81227,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81167,87 +81235,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team_add + subcategory: sub-issues supported-webhook-types: - repository - organization - app - team-added-to-repository: + sub-issues-sub-issue-removed: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was granted access to a repository. - operationId: team/added-to-repository - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: team - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-team-added-to-repository" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: team - supported-webhook-types: - - organization - - business - - app - team-created: - post: - summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + 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 "Members" organization permission. - description: A team was created. - operationId: team/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was removed from an issue. + operationId: sub-issues/sub-issue-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -81261,7 +81265,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: team + example: sub_issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81289,7 +81293,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81297,22 +81301,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sub-issues supported-webhook-types: + - repository - organization - - business - app - team-deleted: + team-add: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when a team is added to a repository. + For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + + For activity relating to teams, see the `teams` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was deleted. - operationId: team/deleted + operationId: team-add externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add parameters: - name: User-Agent in: header @@ -81326,7 +81331,202 @@ webhooks: type: string - name: X-Github-Event in: header - example: team + example: team_add + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-add" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team_add + supported-webhook-types: + - repository + - organization + - app + team-added-to-repository: + post: + summary: |- + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was granted access to a repository. + operationId: team/added-to-repository + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: team + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-added-to-repository" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team + supported-webhook-types: + - organization + - business + - app + team-created: + post: + summary: |- + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was created. + operationId: team/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: team + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team + supported-webhook-types: + - organization + - business + - app + team-deleted: + post: + summary: |- + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was deleted. + operationId: team/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: team schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -96608,6 +96808,8 @@ components: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" require_code_owner_review: type: boolean description: Require an approving review in pull requests that modify @@ -110533,6 +110735,172 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + secret-scanning-alert-metadata: + type: array + description: A list of metadata key/value pairs associated with the secret scanning + alert. + readOnly: true + items: + type: object + properties: + key: + type: string + description: The metadata key. + value: + type: string + description: The metadata value. + required: + - key + - value + secret-scanning-alert-with-metadata: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + "$ref": "#/components/schemas/secret-scanning-alert-state" + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + provider: + type: + - string + - 'null' + description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. Use this value for filtering by provider with the `providers` + or `exclude_providers` parameters. + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the detected secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple repositories + under the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert is base64 + encoded + first_location_detected: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/secret-scanning-first-detected-location" + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token in the + alert was detected in more than one location. + assigned_to: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + closure_request_comment: + type: + - string + - 'null' + description: An optional comment from the closure request author. + closure_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment from the closure request reviewer. + closure_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + metadata: + "$ref": "#/components/schemas/secret-scanning-alert-metadata" secret-scanning-alert-resolution-comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -122949,6 +123317,8 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + metadata: + "$ref": "#/components/schemas/secret-scanning-alert-metadata" webhooks_security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -196607,53 +196977,2306 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: - "$ref": "#/components/schemas/simple-user" - required: - - requested_team - - action - - number - - pull_request - - repository - - sender - webhook-pull-request-review-submitted: - title: pull_request_review submitted event + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: + "$ref": "#/components/schemas/simple-user" + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-review-submitted: + title: pull_request_review submitted event + type: object + properties: + action: + type: string + enum: + - submitted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments_url: + type: string + format: uri + commits_url: + type: string + format: uri + created_at: + type: string + diff_url: + type: string + format: uri + draft: + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: + "$ref": "#/components/schemas/repository-webhooks" + review: + "$ref": "#/components/schemas/webhooks_review" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - review + - pull_request + - repository + - sender + webhook-pull-request-review-thread-resolved: + title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - - submitted + - resolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -196821,7 +199444,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -196895,7 +199517,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -197235,28 +199856,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -197396,28 +199995,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -197873,28 +200450,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -198034,28 +200589,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -198395,7 +200928,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198889,24 +201421,331 @@ components: - active_lock_reason repository: "$ref": "#/components/schemas/repository-webhooks" - review: - "$ref": "#/components/schemas/webhooks_review" sender: "$ref": "#/components/schemas/simple-user" + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment + applies. + type: string + original_line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff to which + the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the comment + applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review comment + belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be + a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - - review + - thread - pull_request - repository - - sender - webhook-pull-request-review-thread-resolved: - title: pull_request_review_thread resolved event + webhook-pull-request-review-thread-unresolved: + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - resolved + - unresolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -199180,9 +202019,7 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -199860,17 +202697,13 @@ components: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -200695,7 +203528,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -200806,15 +203638,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -201004,7 +203827,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -201149,9 +203971,7 @@ components: original_line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment - type: - - integer - - 'null' + type: integer original_position: description: The index of the original line in the diff to which the comment applies. @@ -201318,7 +204138,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -201368,22 +204187,24 @@ components: - thread - pull_request - repository - webhook-pull-request-review-thread-unresolved: - title: pull_request_review_thread unresolved event + webhook-pull-request-stacked: + title: pull_request stacked event type: object properties: action: type: string enum: - - unresolved + - stacked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Simple Pull Request + title: Pull Request type: object properties: _links: @@ -201480,6 +204301,8 @@ components: - too heated - spam - + additions: + type: integer assignee: title: User type: @@ -201543,6 +204366,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -201616,6 +204440,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -201649,7 +204474,9 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -201953,6 +204780,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -202092,6 +204941,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -202306,34 +205177,49 @@ components: type: - string - 'null' + changed_files: + type: integer closed_at: type: - string - 'null' + format: date-time + comments: + type: integer comments_url: type: string format: uri + commits: + type: integer commits_url: type: string format: uri created_at: type: string + format: date-time + deletions: + type: integer diff_url: type: string format: uri draft: + description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -202543,6 +205429,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -202682,6 +205590,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -202937,10 +205867,96 @@ components: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' merged_at: type: - string - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -203021,6 +206037,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203088,10 +206105,16 @@ components: node_id: type: string number: + description: Number uniquely identifying the pull request within its + repository. type: integer patch_url: type: string format: uri + rebaseable: + type: + - boolean + - 'null' requested_reviewers: type: array items: @@ -203158,6 +206181,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203268,6 +206292,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -203375,10 +206408,13 @@ components: review_comment_url: type: string format: uri-template + review_comments: + type: integer review_comments_url: type: string format: uri state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -203387,9 +206423,11 @@ components: type: string format: uri title: + description: The title of the pull request. type: string updated_at: type: string + format: date-time url: type: string format: uri @@ -203457,6 +206495,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203489,7 +206528,6 @@ components: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -203501,322 +206539,17 @@ components: - author_association - auto_merge - active_lock_reason + - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. - type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the comment - applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review comment - belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be - a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: - - string - - 'null' - format: date-time required: - action - - thread + - number - pull_request - repository + - sender webhook-pull-request-synchronize: title: pull_request synchronize event type: object @@ -216573,6 +219306,54 @@ components: type: string required: - payload + webhook-secret-scanning-alert-metadata-created: + title: secret_scanning_alert metadata created event + type: object + properties: + action: + type: string + enum: + - metadata_created + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository + webhook-secret-scanning-alert-metadata-removed: + title: secret_scanning_alert metadata removed event + type: object + properties: + action: + type: string + enum: + - metadata_removed + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-publicly-leaked: title: secret_scanning_alert publicly leaked event type: object @@ -248019,6 +250800,9 @@ components: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com secret-scanning-alert-resolved: value: number: 42 @@ -248062,6 +250846,9 @@ components: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -255194,6 +257981,29 @@ components: required: false schema: type: boolean + secret-scanning-alert-included-metadata: + name: included_metadata + in: query + description: |- + A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the + specified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`, + `owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`, + `organization-id`, `last-used-date`, and `has-organization-access`. + required: false + schema: + type: string + secret-scanning-alert-owner-email-hash: + name: owner_email_hash + in: query + description: |- + Filters alerts to only those whose attached `owner_email` metadata field matches the + provided value. The value must be the lowercase hex-encoded SHA-256 hash of the email + address to match (for example, the SHA-256 of `user@example.com`). Only alerts that + have an `owner_email` metadata value whose SHA-256 hash equals this parameter are + returned. + required: false + schema: + type: string network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index c5d6152197..4709680a75 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -36523,6 +36523,12 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" } ], "responses": { @@ -72885,6 +72891,12 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" } ], "responses": { @@ -72953,7 +72965,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -73081,7 +73093,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -106786,6 +106798,99 @@ } } }, + "pull-request-stacked": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-stacked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", @@ -110242,11 +110347,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-metadata-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "Metadata was created for a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110313,7 +110418,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-created" } } } @@ -110324,7 +110429,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -110335,11 +110439,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-metadata-removed": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "Metadata was removed from a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110406,7 +110510,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-removed" } } } @@ -110417,7 +110521,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -110428,11 +110531,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-publicly-leaked": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110499,7 +110602,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -110521,11 +110624,11 @@ } } }, - "secret-scanning-alert-unassigned": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was unassigned.", - "operationId": "secret-scanning-alert/unassigned", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110592,7 +110695,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -110614,11 +110717,11 @@ } } }, - "secret-scanning-alert-validated": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was validated.", - "operationId": "secret-scanning-alert/validated", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110685,7 +110788,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -110707,13 +110810,13 @@ } } }, - "secret-scanning-scan-completed": { + "secret-scanning-alert-unassigned": { "post": { - "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning scan was completed.", - "operationId": "secret-scanning-scan/completed", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110735,7 +110838,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_scan", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110778,7 +110881,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -110791,7 +110894,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_scan", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -110800,13 +110903,13 @@ } } }, - "security-advisory-published": { + "secret-scanning-alert-validated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A security advisory was published to the GitHub community.", - "operationId": "security-advisory/published", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110828,7 +110931,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110871,7 +110974,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -110884,20 +110987,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-updated": { + "secret-scanning-scan-completed": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed.", - "operationId": "security-advisory/updated", + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning scan was completed.", + "operationId": "secret-scanning-scan/completed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" }, "parameters": [ { @@ -110919,7 +111024,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_scan", "schema": { "type": "string" } @@ -110962,7 +111067,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -110975,18 +111080,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_scan", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-withdrawn": { + "security-advisory-published": { "post": { "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A previously published security advisory was withdrawn.", - "operationId": "security-advisory/withdrawn", + "description": "A security advisory was published to the GitHub community.", + "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, @@ -111053,7 +111160,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -111073,12 +111180,13 @@ } } }, - "security-and-analysis": { + "security-advisory-updated": { "post": { - "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "operationId": "security-and-analysis", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -111100,7 +111208,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_and_analysis", + "example": "security_advisory", "schema": { "type": "string" } @@ -111143,7 +111251,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -111156,22 +111264,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "security_advisory", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "sponsorship-cancelled": { + "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/cancelled", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -111193,7 +111299,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_advisory", "schema": { "type": "string" } @@ -111236,7 +111342,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -111249,20 +111355,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_advisory", "supported-webhook-types": [ - "sponsors_listing" + "app" ] } } }, - "sponsorship-created": { + "security-and-analysis": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", - "operationId": "sponsorship/created", + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "operationId": "security-and-analysis", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -111284,7 +111389,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_and_analysis", "schema": { "type": "string" } @@ -111327,7 +111432,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -111340,18 +111445,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_and_analysis", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "sponsorship-edited": { + "sponsorship-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", - "operationId": "sponsorship/edited", + "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111418,7 +111525,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -111438,11 +111545,11 @@ } } }, - "sponsorship-pending-cancellation": { + "sponsorship-created": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/pending-cancellation", + "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", + "operationId": "sponsorship/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111509,7 +111616,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -111529,11 +111636,11 @@ } } }, - "sponsorship-pending-tier-change": { + "sponsorship-edited": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", - "operationId": "sponsorship/pending-tier-change", + "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", + "operationId": "sponsorship/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111600,7 +111707,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -111620,11 +111727,11 @@ } } }, - "sponsorship-tier-changed": { + "sponsorship-pending-cancellation": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", - "operationId": "sponsorship/tier-changed", + "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/pending-cancellation", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111691,7 +111798,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -111711,13 +111818,13 @@ } } }, - "star-created": { + "sponsorship-pending-tier-change": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone starred a repository.", - "operationId": "star/created", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", + "operationId": "sponsorship/pending-tier-change", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111739,7 +111846,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111782,7 +111889,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -111795,22 +111902,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "star-deleted": { + "sponsorship-tier-changed": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone unstarred the repository.", - "operationId": "star/deleted", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", + "operationId": "sponsorship/tier-changed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111832,7 +111937,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111875,7 +111980,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -111888,21 +111993,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "status": { + "star-created": { "post": { - "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", - "operationId": "status", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone starred a repository.", + "operationId": "star/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -111924,7 +112028,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "status", + "example": "star", "schema": { "type": "string" } @@ -111967,7 +112071,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -111980,7 +112084,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111989,13 +112093,13 @@ } } }, - "sub-issues-parent-issue-added": { + "star-deleted": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was added to an issue.", - "operationId": "sub-issues/parent-issue-added", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone unstarred the repository.", + "operationId": "star/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -112017,7 +112121,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "star", "schema": { "type": "string" } @@ -112060,7 +112164,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -112073,7 +112177,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -112082,13 +112186,12 @@ } } }, - "sub-issues-parent-issue-removed": { + "status": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was removed from an issue.", - "operationId": "sub-issues/parent-issue-removed", + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "operationId": "status", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -112110,7 +112213,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "status", "schema": { "type": "string" } @@ -112153,7 +112256,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" } } } @@ -112166,7 +112269,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "status", "supported-webhook-types": [ "repository", "organization", @@ -112175,11 +112278,11 @@ } } }, - "sub-issues-sub-issue-added": { + "sub-issues-parent-issue-added": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was added to an issue.", - "operationId": "sub-issues/sub-issue-added", + "description": "A parent issue was added to an issue.", + "operationId": "sub-issues/parent-issue-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -112246,7 +112349,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -112268,11 +112371,11 @@ } } }, - "sub-issues-sub-issue-removed": { + "sub-issues-parent-issue-removed": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was removed from an issue.", - "operationId": "sub-issues/sub-issue-removed", + "description": "A parent issue was removed from an issue.", + "operationId": "sub-issues/parent-issue-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -112339,7 +112442,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -112361,12 +112464,13 @@ } } }, - "team-add": { + "sub-issues-sub-issue-added": { "post": { - "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "operationId": "team-add", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was added to an issue.", + "operationId": "sub-issues/sub-issue-added", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -112388,7 +112492,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team_add", + "example": "sub_issues", "schema": { "type": "string" } @@ -112431,7 +112535,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -112444,7 +112548,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "sub-issues", "supported-webhook-types": [ "repository", "organization", @@ -112453,13 +112557,13 @@ } } }, - "team-added-to-repository": { + "sub-issues-sub-issue-removed": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was granted access to a repository.", - "operationId": "team/added-to-repository", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was removed from an issue.", + "operationId": "sub-issues/sub-issue-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -112481,7 +112585,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "sub_issues", "schema": { "type": "string" } @@ -112524,7 +112628,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -112537,22 +112641,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "sub-issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-created": { + "team-add": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was created.", - "operationId": "team/created", + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "operationId": "team-add", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -112574,7 +112677,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "team_add", "schema": { "type": "string" } @@ -112617,7 +112720,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -112630,20 +112733,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "team_add", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-deleted": { + "team-added-to-repository": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was deleted.", - "operationId": "team/deleted", + "description": "A team was granted access to a repository.", + "operationId": "team/added-to-repository", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112710,7 +112813,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -112732,11 +112835,11 @@ } } }, - "team-edited": { + "team-created": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name, description, or visibility of a team was changed.", - "operationId": "team/edited", + "description": "A team was created.", + "operationId": "team/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112803,7 +112906,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -112825,11 +112928,11 @@ } } }, - "team-removed-from-repository": { + "team-deleted": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team's access to a repository was removed.", - "operationId": "team/removed-from-repository", + "description": "A team was deleted.", + "operationId": "team/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112896,7 +112999,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-deleted" } } } @@ -112918,13 +113021,13 @@ } } }, - "watch-started": { + "team-edited": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone started watching the repository.", - "operationId": "watch/started", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name, description, or visibility of a team was changed.", + "operationId": "team/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -112946,7 +113049,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "watch", + "example": "team", "schema": { "type": "string" } @@ -112989,7 +113092,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-edited" } } } @@ -113002,21 +113105,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "watch", + "subcategory": "team", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "workflow-dispatch": { + "team-removed-from-repository": { "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "workflow-dispatch", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team's access to a repository was removed.", + "operationId": "team/removed-from-repository", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -113038,7 +113142,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_dispatch", + "example": "team", "schema": { "type": "string" } @@ -113081,7 +113185,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" } } } @@ -113094,20 +113198,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_dispatch", + "subcategory": "team", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "workflow-job-completed": { + "watch-started": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", - "operationId": "workflow-job/completed", + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone started watching the repository.", + "operationId": "watch/started", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" }, "parameters": [ { @@ -113129,7 +113235,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "watch", "schema": { "type": "string" } @@ -113172,7 +113278,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-watch-started" } } } @@ -113185,9 +113291,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "watch", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -113195,13 +113300,12 @@ } } }, - "workflow-job-in-progress": { + "workflow-dispatch": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run started processing on a runner.", - "operationId": "workflow-job/in-progress", + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "workflow-dispatch", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" }, "parameters": [ { @@ -113223,7 +113327,192 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "workflow_dispatch", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-dispatch" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "workflow-job-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", + "operationId": "workflow-job/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_job", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run started processing on a runner.", + "operationId": "workflow-job/in-progress", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_job", "schema": { "type": "string" } @@ -133963,6 +134252,9 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -153910,6 +154202,255 @@ } } }, + "secret-scanning-alert-metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } + }, + "secret-scanning-alert-with-metadata": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/alert-updated-at" + } + ] + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise." + }, + "is_base64_encoded": { + "type": [ + "boolean", + "null" + ], + "description": "A boolean value representing whether or not alert is base64 encoded" + }, + "first_location_detected": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/secret-scanning-first-detected-location" + } + ] + }, + "has_more_locations": { + "type": "boolean", + "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "metadata": { + "$ref": "#/components/schemas/secret-scanning-alert-metadata" + } + } + }, "secret-scanning-alert-resolution-comment": { "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": [ @@ -170578,6 +171119,9 @@ "$ref": "#/components/schemas/simple-user" } ] + }, + "metadata": { + "$ref": "#/components/schemas/secret-scanning-alert-metadata" } } }, @@ -270973,8 +271517,3029 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": [ + "string", + "null" + ] + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "review": { + "$ref": "#/components/schemas/webhooks_review" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "review", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-review-thread-resolved": { + "title": "pull_request_review_thread resolved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolved" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Simple Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, "url": { @@ -271436,23 +275001,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -271652,23 +275200,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -271724,11 +275255,6 @@ "type": "string", "format": "uri" }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "type": "boolean", - "default": false - }, "visibility": { "type": "string", "enum": [ @@ -272269,23 +275795,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -272485,23 +275994,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -272557,11 +276049,6 @@ "type": "string", "format": "uri" }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "type": "boolean", - "default": false - }, "visibility": { "type": "string", "enum": [ @@ -272948,8 +276435,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -273611,35 +277097,417 @@ "repository": { "$ref": "#/components/schemas/repository-webhooks" }, - "review": { - "$ref": "#/components/schemas/webhooks_review" - }, "sender": { "$ref": "#/components/schemas/simple-user" + }, + "thread": { + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "title": "Pull Request Review Comment", + "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "type": "string" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies.", + "type": "integer" + }, + "original_start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "enum": [ + "LEFT", + "RIGHT" + ] + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": [ + "string", + "null" + ], + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the pull request review comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links", + "start_line", + "original_start_line", + "original_line", + "line", + "start_side", + "side", + "reactions" + ] + } + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "node_id", + "comments" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ "action", - "review", + "thread", "pull_request", - "repository", - "sender" + "repository" ], "x-github-breaking-changes": [ - { - "changeset": "remove_use_squash_pr_title_as_default", - "patch": [ - { - "op": "remove", - "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - }, - { - "op": "remove", - "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - } - ], - "version": "2026-03-10" - }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ @@ -273656,14 +277524,14 @@ } ] }, - "webhook-pull-request-review-thread-resolved": { - "title": "pull_request_review_thread resolved event", + "webhook-pull-request-review-thread-unresolved": { + "title": "pull_request_review_thread unresolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unresolved" ] }, "enterprise": { @@ -274041,10 +277909,7 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": [ - "string", - "null" - ] + "type": "string" }, "enabled_by": { "title": "User", @@ -274954,10 +278819,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -274965,10 +278827,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -276078,8 +279937,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -276227,16 +280085,7 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "id" ] } ] @@ -276493,8 +280342,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -276676,10 +280524,7 @@ }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] + "type": "integer" }, "original_position": { "description": "The index of the original line in the diff to which the comment applies.", @@ -276893,8 +280738,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -276980,14 +280824,14 @@ } ] }, - "webhook-pull-request-review-thread-unresolved": { - "title": "pull_request_review_thread unresolved event", + "webhook-pull-request-stacked": { + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unresolved" + "stacked" ] }, "enterprise": { @@ -276996,11 +280840,14 @@ "installation": { "$ref": "#/components/schemas/simple-installation" }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { - "title": "Simple Pull Request", + "title": "Pull Request", "type": "object", "properties": { "_links": { @@ -277135,6 +280982,9 @@ null ] }, + "additions": { + "type": "integer" + }, "assignee": { "title": "User", "type": [ @@ -277218,7 +281068,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277319,7 +281170,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277365,7 +281217,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -277778,6 +281633,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -277977,6 +281849,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -278032,6 +281921,11 @@ "type": "string", "format": "uri" }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, "visibility": { "type": "string", "enum": [ @@ -278247,35 +282141,53 @@ "null" ] }, + "changed_files": { + "type": "integer" + }, "closed_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" + }, + "comments": { + "type": "integer" }, "comments_url": { "type": "string", "format": "uri" }, + "commits": { + "type": "integer" + }, "commits_url": { "type": "string", "format": "uri" }, "created_at": { - "type": "string" + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" }, "diff_url": { "type": "string", "format": "uri" }, "draft": { + "description": "Indicates whether or not the pull request is a draft.", "type": "boolean" }, "head": { "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -278283,7 +282195,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -278566,6 +282481,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -278765,6 +282697,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -278820,6 +282769,11 @@ "type": "string", "format": "uri" }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, "visibility": { "type": "string", "enum": [ @@ -279089,16 +283043,136 @@ "locked": { "type": "boolean" }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, "merge_commit_sha": { "type": [ "string", "null" ] }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, "merged_at": { "type": [ "string", "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "milestone": { @@ -279206,7 +283280,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -279300,12 +283375,19 @@ "type": "string" }, "number": { + "description": "Number uniquely identifying the pull request within its repository.", "type": "integer" }, "patch_url": { "type": "string", "format": "uri" }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, "requested_reviewers": { "type": "array", "items": { @@ -279393,7 +283475,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -279541,7 +283624,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -279689,11 +283781,15 @@ "type": "string", "format": "uri-template" }, + "review_comments": { + "type": "integer" + }, "review_comments_url": { "type": "string", "format": "uri" }, "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", "enum": [ "open", @@ -279705,10 +283801,12 @@ "format": "uri" }, "title": { + "description": "The title of the pull request.", "type": "string" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "url": { "type": "string", @@ -279798,7 +283896,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -279840,7 +283939,6 @@ "requested_teams", "labels", "milestone", - "draft", "commits_url", "review_comments_url", "review_comment_url", @@ -279851,7 +283949,8 @@ "_links", "author_association", "auto_merge", - "active_lock_reason" + "active_lock_reason", + "draft" ] }, "repository": { @@ -279859,411 +283958,30 @@ }, "sender": { "$ref": "#/components/schemas/simple-user" - }, - "thread": { - "type": "object", - "properties": { - "comments": { - "type": "array", - "items": { - "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", - "type": "integer" - }, - "original_start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": "string", - "enum": [ - "LEFT", - "RIGHT" - ] - }, - "start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": [ - "string", - "null" - ], - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the pull request review comment", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links", - "start_line", - "original_start_line", - "original_line", - "line", - "start_side", - "side", - "reactions" - ] - } - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "node_id", - "comments" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } }, "required": [ "action", - "thread", + "number", "pull_request", - "repository" + "repository", + "sender" ], "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ @@ -297282,18 +301000,263 @@ "sender" ] }, - "webhook-repository-vulnerability-alert-reopen": { - "title": "repository_vulnerability_alert reopen event", + "webhook-repository-vulnerability-alert-reopen": { + "title": "repository_vulnerability_alert reopen event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopen" + ] + }, + "alert": { + "$ref": "#/components/schemas/webhooks_alert" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-repository-vulnerability-alert-resolve": { + "title": "repository_vulnerability_alert resolve event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolve" + ] + }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "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" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "fixed", + "open" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopen" + "assigned" ] }, "alert": { - "$ref": "#/components/schemas/webhooks_alert" + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -297314,192 +301277,21 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] }, - "webhook-repository-vulnerability-alert-resolve": { - "title": "repository_vulnerability_alert resolve event", + "webhook-secret-scanning-alert-created": { + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "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" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] - } - } + "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -297520,32 +301312,28 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] }, - "webhook-secret-scanning-alert-assigned": { - "title": "secret_scanning_alert assigned event", + "webhook-secret-scanning-alert-location-created": { + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "assigned" + "created" ] }, "alert": { "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, - "assignee": { - "$ref": "#/components/schemas/simple-user" - }, - "enterprise": { - "$ref": "#/components/schemas/enterprise-webhooks" - }, "installation": { "$ref": "#/components/schemas/simple-installation" }, + "location": { + "$ref": "#/components/schemas/secret-scanning-location" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, @@ -297557,19 +301345,33 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" ] }, - "webhook-secret-scanning-alert-created": { - "title": "secret_scanning_alert created event", + "webhook-secret-scanning-alert-location-created-form-encoded": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "webhook-secret-scanning-alert-metadata-created": { + "title": "secret_scanning_alert metadata created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_created" ] }, "alert": { @@ -297597,25 +301399,25 @@ "repository" ] }, - "webhook-secret-scanning-alert-location-created": { - "title": "Secret Scanning Alert Location Created Event", + "webhook-secret-scanning-alert-metadata-removed": { + "title": "secret_scanning_alert metadata removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_removed" ] }, "alert": { "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "installation": { "$ref": "#/components/schemas/simple-installation" }, - "location": { - "$ref": "#/components/schemas/secret-scanning-location" - }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, @@ -297627,23 +301429,9 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "webhook-secret-scanning-alert-location-created-form-encoded": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] }, "webhook-secret-scanning-alert-publicly-leaked": { @@ -335877,7 +339665,13 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ] } }, "secret-scanning-alert-resolved": { @@ -335924,6 +339718,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -344160,6 +347960,24 @@ "type": "boolean" } }, + "secret-scanning-alert-included-metadata": { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-owner-email-hash": { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index b136960dca..1ca3f8a58f 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -26844,6 +26844,8 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + - "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + - "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" responses: '200': description: Response @@ -53290,6 +53292,8 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" + - "$ref": "#/components/parameters/secret-scanning-alert-included-metadata" + - "$ref": "#/components/parameters/secret-scanning-alert-owner-email-hash" responses: '200': description: Response @@ -53338,7 +53342,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" examples: default: "$ref": "#/components/examples/secret-scanning-alert-open" @@ -53425,7 +53429,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" examples: default: "$ref": "#/components/examples/secret-scanning-alert-resolved" @@ -77544,6 +77548,72 @@ webhooks: - repository - organization - app + pull-request-stacked: + post: + summary: |- + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request was added to a stack. + operationId: pull-request/stacked + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: pull_request + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-pull-request-stacked" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app pull-request-synchronize: post: summary: |- @@ -79971,7 +80041,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-publicly-leaked: + secret-scanning-alert-metadata-created: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -79979,8 +80049,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was detected in a public repo. - operationId: secret-scanning-alert/publicly-leaked + description: Metadata was created for a secret scanning alert. + operationId: secret-scanning-alert/metadata-created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -80024,20 +80094,19 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - secret-scanning-alert-reopened: + secret-scanning-alert-metadata-removed: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -80045,8 +80114,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A previously closed secret scanning alert was reopened. - operationId: secret-scanning-alert/reopened + description: Metadata was removed from a secret scanning alert. + operationId: secret-scanning-alert/metadata-removed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -80090,20 +80159,19 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - secret-scanning-alert-resolved: + secret-scanning-alert-publicly-leaked: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -80111,8 +80179,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was closed. - operationId: secret-scanning-alert/resolved + description: A secret scanning alert was detected in a public repo. + operationId: secret-scanning-alert/publicly-leaked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -80156,7 +80224,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80169,7 +80237,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-unassigned: + secret-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -80177,8 +80245,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was unassigned. - operationId: secret-scanning-alert/unassigned + description: A previously closed secret scanning alert was reopened. + operationId: secret-scanning-alert/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -80222,7 +80290,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80235,7 +80303,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-validated: + secret-scanning-alert-resolved: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -80243,8 +80311,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was validated. - operationId: secret-scanning-alert/validated + description: A secret scanning alert was closed. + operationId: secret-scanning-alert/resolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -80288,7 +80356,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80301,19 +80369,18 @@ webhooks: - repository - organization - app - secret-scanning-scan-completed: + secret-scanning-alert-unassigned: post: summary: |- - This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates - to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning scan was completed. - operationId: secret-scanning-scan/completed + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -80327,7 +80394,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: secret_scanning_scan + example: secret_scanning_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80355,7 +80422,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80363,21 +80430,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_scan + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - security-advisory-published: + secret-scanning-alert-validated: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A security advisory was published to the GitHub community. - operationId: security-advisory/published + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was validated. + operationId: secret-scanning-alert/validated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -80391,7 +80460,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: security_advisory + example: secret_scanning_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80419,7 +80488,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80427,19 +80496,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: secret_scanning_alert supported-webhook-types: + - repository + - organization - app - security-advisory-updated: + secret-scanning-scan-completed: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: The metadata or description of a security advisory was changed. - operationId: security-advisory/updated + Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates + to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning scan was completed. + operationId: secret-scanning-scan/completed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan parameters: - name: User-Agent in: header @@ -80453,7 +80527,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: security_advisory + example: secret_scanning_scan schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80481,7 +80555,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80489,17 +80563,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: secret_scanning_scan supported-webhook-types: + - repository + - organization - app - security-advisory-withdrawn: + security-advisory-published: post: summary: |- This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A previously published security advisory was withdrawn. - operationId: security-advisory/withdrawn + description: A security advisory was published to the GitHub community. + operationId: security-advisory/published externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: @@ -80543,7 +80619,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80554,15 +80630,16 @@ webhooks: subcategory: security_advisory supported-webhook-types: - app - security-and-analysis: + security-advisory-updated: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: The metadata or description of a security advisory was changed. + operationId: security-advisory/updated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -80576,7 +80653,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: security_and_analysis + example: security_advisory schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80604,7 +80681,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80612,24 +80689,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_and_analysis + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sponsorship-cancelled: + security-advisory-withdrawn: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsorship was cancelled and the last billing cycle has ended. + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: A previously published security advisory was withdrawn. + operationId: security-advisory/withdrawn externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -80643,7 +80715,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sponsorship + example: security_advisory schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80671,7 +80743,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80679,20 +80751,18 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security_advisory supported-webhook-types: - - sponsors_listing - sponsorship-created: + - app + security-and-analysis: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor created a sponsorship for a sponsored account. This event - occurs once the payment is successfully processed. - operationId: sponsorship/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + operationId: security-and-analysis externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header @@ -80706,7 +80776,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sponsorship + example: security_and_analysis schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80734,7 +80804,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80742,19 +80812,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security_and_analysis supported-webhook-types: - - sponsors_listing - sponsorship-edited: + - repository + - organization + - app + sponsorship-cancelled: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A monthly sponsor changed who can see their sponsorship. If you - recognize your sponsors publicly, you may want to update your sponsor recognition - to reflect the change when this event occurs. - operationId: sponsorship/edited + description: |- + A sponsorship was cancelled and the last billing cycle has ended. + + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/cancelled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80798,7 +80871,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80809,17 +80882,15 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-cancellation: + sponsorship-created: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. - - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + description: A sponsor created a sponsorship for a sponsored account. This event + occurs once the payment is successfully processed. + operationId: sponsorship/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80863,7 +80934,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80874,15 +80945,16 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-tier-change: + sponsorship-edited: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor scheduled a downgrade to a lower sponsorship tier. The - new tier will become effective on their next billing date. - operationId: sponsorship/pending-tier-change + description: A monthly sponsor changed who can see their sponsorship. If you + recognize your sponsors publicly, you may want to update your sponsor recognition + to reflect the change when this event occurs. + operationId: sponsorship/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80926,7 +80998,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80937,17 +81009,17 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-tier-changed: + sponsorship-pending-cancellation: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor changed the tier of their sponsorship and the change - has taken effect. If a sponsor upgraded their tier, the change took effect - immediately. If a sponsor downgraded their tier, the change took effect at - the beginning of the sponsor's next billing cycle. - operationId: sponsorship/tier-changed + description: |- + A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/pending-cancellation externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -80991,7 +81063,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81002,16 +81074,17 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - star-created: + sponsorship-pending-tier-change: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone starred a repository. - operationId: star/created + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor scheduled a downgrade to a lower sponsorship tier. The + new tier will become effective on their next billing date. + operationId: sponsorship/pending-tier-change externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -81025,7 +81098,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: star + example: sponsorship schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81053,7 +81126,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81061,21 +81134,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - star-deleted: + - sponsors_listing + sponsorship-tier-changed: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone unstarred the repository. - operationId: star/deleted + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor changed the tier of their sponsorship and the change + has taken effect. If a sponsor upgraded their tier, the change took effect + immediately. If a sponsor downgraded their tier, the change took effect at + the beginning of the sponsor's next billing cycle. + operationId: sponsorship/tier-changed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -81089,7 +81163,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: star + example: sponsorship schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81117,7 +81191,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81125,20 +81199,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - status: + - sponsors_listing + star-created: post: summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. - operationId: status + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone starred a repository. + operationId: star/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#status + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -81152,7 +81225,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: status + example: star schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81180,7 +81253,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81188,23 +81261,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: status + subcategory: star supported-webhook-types: - repository - organization - app - sub-issues-parent-issue-added: + star-deleted: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was added to an issue. - operationId: sub-issues/parent-issue-added + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone unstarred the repository. + operationId: star/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -81218,7 +81289,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sub_issues + example: star schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81246,7 +81317,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81254,23 +81325,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: star supported-webhook-types: - repository - organization - app - sub-issues-parent-issue-removed: + status: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was removed from an issue. - operationId: sub-issues/parent-issue-removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. + operationId: status externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header @@ -81284,7 +81352,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: sub_issues + example: status schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81312,7 +81380,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81320,12 +81388,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: status supported-webhook-types: - repository - organization - app - sub-issues-sub-issue-added: + sub-issues-parent-issue-added: post: summary: |- This event occurs when there is activity relating to sub-issues. @@ -81333,8 +81401,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: A sub-issue was added to an issue. - operationId: sub-issues/sub-issue-added + description: A parent issue was added to an issue. + operationId: sub-issues/parent-issue-added externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: @@ -81378,7 +81446,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81391,7 +81459,7 @@ webhooks: - repository - organization - app - sub-issues-sub-issue-removed: + sub-issues-parent-issue-removed: post: summary: |- This event occurs when there is activity relating to sub-issues. @@ -81399,8 +81467,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: A sub-issue was removed from an issue. - operationId: sub-issues/sub-issue-removed + description: A parent issue was removed from an issue. + operationId: sub-issues/parent-issue-removed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: @@ -81444,7 +81512,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81457,18 +81525,18 @@ webhooks: - repository - organization - app - team-add: + sub-issues-sub-issue-added: post: summary: |- - This event occurs when a team is added to a repository. - For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + This event occurs when there is activity relating to sub-issues. - For activity relating to teams, see the `teams` 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 "Members" organization permission. - operationId: team-add + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was added to an issue. + operationId: sub-issues/sub-issue-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -81482,7 +81550,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: team_add + example: sub_issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81510,7 +81578,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81518,87 +81586,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team_add + subcategory: sub-issues supported-webhook-types: - repository - organization - app - team-added-to-repository: + sub-issues-sub-issue-removed: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was granted access to a repository. - operationId: team/added-to-repository - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: team - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-team-added-to-repository" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: team - supported-webhook-types: - - organization - - business - - app - team-created: - post: - summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + 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 "Members" organization permission. - description: A team was created. - operationId: team/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was removed from an issue. + operationId: sub-issues/sub-issue-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -81612,7 +81616,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: team + example: sub_issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -81640,7 +81644,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81648,22 +81652,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sub-issues supported-webhook-types: + - repository - organization - - business - app - team-deleted: + team-add: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when a team is added to a repository. + For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + + For activity relating to teams, see the `teams` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was deleted. - operationId: team/deleted + operationId: team-add externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add parameters: - name: User-Agent in: header @@ -81677,7 +81682,202 @@ webhooks: type: string - name: X-Github-Event in: header - example: team + example: team_add + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-add" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team_add + supported-webhook-types: + - repository + - organization + - app + team-added-to-repository: + post: + summary: |- + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was granted access to a repository. + operationId: team/added-to-repository + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: team + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-added-to-repository" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team + supported-webhook-types: + - organization + - business + - app + team-created: + post: + summary: |- + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was created. + operationId: team/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: team + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team + supported-webhook-types: + - organization + - business + - app + team-deleted: + post: + summary: |- + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was deleted. + operationId: team/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: team schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -97632,6 +97832,8 @@ components: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" require_code_owner_review: type: boolean description: Require an approving review in pull requests that modify @@ -111833,6 +112035,172 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + secret-scanning-alert-metadata: + type: array + description: A list of metadata key/value pairs associated with the secret scanning + alert. + readOnly: true + items: + type: object + properties: + key: + type: string + description: The metadata key. + value: + type: string + description: The metadata value. + required: + - key + - value + secret-scanning-alert-with-metadata: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + "$ref": "#/components/schemas/secret-scanning-alert-state" + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + provider: + type: + - string + - 'null' + description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. Use this value for filtering by provider with the `providers` + or `exclude_providers` parameters. + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the detected secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple repositories + under the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert is base64 + encoded + first_location_detected: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/secret-scanning-first-detected-location" + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token in the + alert was detected in more than one location. + assigned_to: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + closure_request_comment: + type: + - string + - 'null' + description: An optional comment from the closure request author. + closure_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment from the closure request reviewer. + closure_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + metadata: + "$ref": "#/components/schemas/secret-scanning-alert-metadata" secret-scanning-alert-resolution-comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -124179,6 +124547,8 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + metadata: + "$ref": "#/components/schemas/secret-scanning-alert-metadata" webhooks_security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -198286,76 +198656,2361 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: - "$ref": "#/components/schemas/simple-user" - required: - - requested_team - - action - - number - - pull_request - - repository - - sender + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: + "$ref": "#/components/schemas/simple-user" + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + - op: remove + path: "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + version: '2026-03-10' + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/oneOf/0/properties/pull_request/properties/merge_commit_sha" + - op: remove + path: "/oneOf/0/properties/pull_request/required/17" + - op: remove + path: "/oneOf/1/properties/pull_request/properties/merge_commit_sha" + - op: remove + path: "/oneOf/1/properties/pull_request/required/17" + version: '2026-03-10' + webhook-pull-request-review-submitted: + title: pull_request_review submitted event + type: object + properties: + action: + type: string + enum: + - submitted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments_url: + type: string + format: uri + commits_url: + type: string + format: uri + created_at: + type: string + diff_url: + type: string + format: uri + draft: + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merge_commit_sha: + type: + - string + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: + "$ref": "#/components/schemas/repository-webhooks" + review: + "$ref": "#/components/schemas/webhooks_review" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - review + - pull_request + - repository + - sender x-github-breaking-changes: - changeset: remove_use_squash_pr_title_as_default patch: - op: remove - path: "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - op: remove - path: "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" version: '2026-03-10' - changeset: remove_pull_request_merge_commit_sha patch: - op: remove - path: "/oneOf/0/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/oneOf/0/properties/pull_request/required/17" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/merge_commit_sha" + path: "/properties/pull_request/properties/merge_commit_sha" - op: remove - path: "/oneOf/1/properties/pull_request/required/17" + path: "/properties/pull_request/required/17" version: '2026-03-10' - webhook-pull-request-review-submitted: - title: pull_request_review submitted event + webhook-pull-request-review-thread-resolved: + title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - - submitted + - resolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -198523,7 +201178,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198597,7 +201251,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198937,28 +201590,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -199098,28 +201729,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -199160,12 +201769,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property is closing down. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -199581,28 +202184,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -199742,28 +202323,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -199804,12 +202363,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property is closing down. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -200113,7 +202666,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -200608,24 +203160,324 @@ components: - active_lock_reason repository: "$ref": "#/components/schemas/repository-webhooks" - review: - "$ref": "#/components/schemas/webhooks_review" sender: "$ref": "#/components/schemas/simple-user" + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment + applies. + type: string + original_line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff to which + the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the comment + applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review comment + belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be + a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - - review + - thread - pull_request - repository - - sender x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - changeset: remove_pull_request_merge_commit_sha patch: - op: remove @@ -200633,14 +203485,14 @@ components: - op: remove path: "/properties/pull_request/required/17" version: '2026-03-10' - webhook-pull-request-review-thread-resolved: - title: pull_request_review_thread resolved event + webhook-pull-request-review-thread-unresolved: + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - resolved + - unresolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -200914,9 +203766,7 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -201594,17 +204444,13 @@ components: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -202433,7 +205279,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -202544,15 +205389,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -202742,7 +205578,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -202888,9 +205723,7 @@ components: original_line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment - type: - - integer - - 'null' + type: integer original_position: description: The index of the original line in the diff to which the comment applies. @@ -203057,7 +205890,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -203115,22 +205947,24 @@ components: - op: remove path: "/properties/pull_request/required/17" version: '2026-03-10' - webhook-pull-request-review-thread-unresolved: - title: pull_request_review_thread unresolved event + webhook-pull-request-stacked: + title: pull_request stacked event type: object properties: action: type: string enum: - - unresolved + - stacked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Simple Pull Request + title: Pull Request type: object properties: _links: @@ -203227,6 +206061,8 @@ components: - too heated - spam - + additions: + type: integer assignee: title: User type: @@ -203290,6 +206126,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203363,6 +206200,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203396,7 +206234,9 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -203700,6 +206540,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -203839,6 +206701,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -203879,6 +206763,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -204053,34 +206943,49 @@ components: type: - string - 'null' + changed_files: + type: integer closed_at: type: - string - 'null' + format: date-time + comments: + type: integer comments_url: type: string format: uri + commits: + type: integer commits_url: type: string format: uri created_at: type: string + format: date-time + deletions: + type: integer diff_url: type: string format: uri draft: + description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -204290,6 +207195,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -204429,6 +207356,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -204469,6 +207418,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -204684,14 +207639,100 @@ components: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean merge_commit_sha: type: - string - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' merged_at: type: - string - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -204772,6 +207813,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -204839,10 +207881,16 @@ components: node_id: type: string number: + description: Number uniquely identifying the pull request within its + repository. type: integer patch_url: type: string format: uri + rebaseable: + type: + - boolean + - 'null' requested_reviewers: type: array items: @@ -204909,6 +207957,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -205019,6 +208068,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -205126,10 +208184,13 @@ components: review_comment_url: type: string format: uri-template + review_comments: + type: integer review_comments_url: type: string format: uri state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -205138,9 +208199,11 @@ components: type: string format: uri title: + description: The title of the pull request. type: string updated_at: type: string + format: date-time url: type: string format: uri @@ -205208,6 +208271,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -205241,7 +208305,6 @@ components: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -205253,323 +208316,25 @@ components: - author_association - auto_merge - active_lock_reason + - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. - type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the comment - applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review comment - belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be - a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: - - string - - 'null' - format: date-time required: - action - - thread + - number - pull_request - repository + - sender x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + - op: remove + path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + version: '2026-03-10' - changeset: remove_pull_request_merge_commit_sha patch: - op: remove @@ -218461,6 +221226,54 @@ components: type: string required: - payload + webhook-secret-scanning-alert-metadata-created: + title: secret_scanning_alert metadata created event + type: object + properties: + action: + type: string + enum: + - metadata_created + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository + webhook-secret-scanning-alert-metadata-removed: + title: secret_scanning_alert metadata removed event + type: object + properties: + action: + type: string + enum: + - metadata_removed + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-publicly-leaked: title: secret_scanning_alert publicly leaked event type: object @@ -250108,6 +252921,9 @@ components: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com secret-scanning-alert-resolved: value: number: 42 @@ -250151,6 +252967,9 @@ components: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -257320,6 +260139,29 @@ components: required: false schema: type: boolean + secret-scanning-alert-included-metadata: + name: included_metadata + in: query + description: |- + A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the + specified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`, + `owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`, + `organization-id`, `last-used-date`, and `has-organization-access`. + required: false + schema: + type: string + secret-scanning-alert-owner-email-hash: + name: owner_email_hash + in: query + description: |- + Filters alerts to only those whose attached `owner_email` metadata field matches the + provided value. The value must be the lowercase hex-encoded SHA-256 hash of the email + address to match (for example, the SHA-256 of `user@example.com`). Only alerts that + have an `owner_email` metadata value whose SHA-256 hash equals this parameter are + returned. + required: false + schema: + type: string network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 1f6e06d4c0..896683d0e0 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -245483,6 +245483,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -246782,6 +246825,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -248155,6 +248241,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -250292,6 +250421,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -251616,6 +251788,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -252985,6 +253200,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -254574,6 +254832,24 @@ "schema": { "type": "boolean" } + }, + { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -665700,6 +665976,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -667566,6 +667885,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -668732,6 +669094,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -670111,6 +670516,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -672267,6 +672715,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -673448,6 +673939,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -674823,6 +675357,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -676428,6 +677005,24 @@ "schema": { "type": "boolean" } + }, + { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -679590,6 +680185,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -679618,7 +680235,13 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ] } } } @@ -681271,6 +681894,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -681319,6 +681964,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -1540728,11 +1541379,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-stacked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1540799,21 +1541450,15 @@ "content": { "application/json": { "schema": { - "title": "pull_request synchronize event", + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "synchronize" + "stacked" ] }, - "after": { - "type": "string" - }, - "before": { - "type": "string" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1542370,7 +1543015,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1542378,7 +1543026,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1542662,7 +1543313,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1542671,7 +1543322,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": [ "PR_TITLE", @@ -1543338,7 +1543989,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1545809,8 +1546461,6 @@ "required": [ "action", "number", - "before", - "after", "pull_request", "repository", "sender" @@ -1545836,11 +1546486,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1545907,114 +1546557,20 @@ "content": { "application/json": { "schema": { - "title": "pull_request unassigned event", + "title": "pull_request synchronize event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unassigned" + "synchronize" ] }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "after": { + "type": "string" + }, + "before": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -1546730,10 +1547286,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1547575,10 +1548128,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1547586,10 +1548136,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1547873,7 +1548420,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1547882,7 +1548429,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1548549,8 +1549096,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -1551021,8 +1551567,11 @@ "required": [ "action", "number", + "before", + "after", "pull_request", - "repository" + "repository", + "sender" ] } } @@ -1551045,11 +1551594,11 @@ } } }, - "pull-request-unlabeled": { + "pull-request-unassigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1551116,13 +1551665,113 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlabeled event", + "title": "pull_request unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" + "unassigned" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -1551240,49 +1551889,6 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "number": { "description": "The pull request number.", "type": "integer" @@ -1551882,7 +1552488,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1553022,7 +1553631,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1553031,7 +1553640,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": [ "PR_TITLE", @@ -1553698,7 +1554307,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1556170,8 +1556780,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ] } } @@ -1556194,11 +1556803,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1556265,13 +1556874,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlocked event", + "title": "pull_request unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlocked" + "unlabeled" ] }, "enterprise": { @@ -1556389,6 +1556998,49 @@ "node_id" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "number": { "description": "The pull request number.", "type": "integer" @@ -1556714,7 +1557366,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1556815,7 +1557468,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1556861,7 +1557515,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -1557825,7 +1558482,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1558120,7 +1558780,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1558129,7 +1558789,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1558917,7 +1559577,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1559111,7 +1559772,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1559259,7 +1559921,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -1559522,7 +1560193,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1561280,12 +1561952,13 @@ } } }, - "push": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1561307,7 +1561980,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "push", + "example": "pull_request", "schema": { "type": "string" } @@ -1561350,158 +1562023,15 @@ "content": { "application/json": { "schema": { - "title": "push event", + "title": "pull_request unlocked event", "type": "object", "properties": { - "after": { - "description": "The SHA of the most recent commit on `ref` after the push.", - "type": "string" - }, - "base_ref": { - "type": [ - "string", - "null" + "action": { + "type": "string", + "enum": [ + "unlocked" ] }, - "before": { - "description": "The SHA of the most recent commit on `ref` before the push.", - "type": "string" - }, - "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits.", - "type": "array", - "items": { - "title": "Commit", - "type": "object", - "properties": { - "added": { - "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "distinct": { - "description": "Whether this commit is distinct from any that have been pushed before.", - "type": "boolean" - }, - "id": { - "type": "string" - }, - "message": { - "description": "The commit message.", - "type": "string" - }, - "modified": { - "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "removed": { - "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "timestamp": { - "description": "The ISO 8601 timestamp of the commit.", - "type": "string", - "format": "date-time" - }, - "tree_id": { - "type": "string" - }, - "url": { - "description": "URL that points to the commit API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "tree_id", - "distinct", - "message", - "timestamp", - "url", - "author", - "committer" - ] - } - }, - "compare": { - "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.", - "type": "string" - }, - "created": { - "description": "Whether this push created the `ref`.", - "type": "boolean" - }, - "deleted": { - "description": "Whether this push deleted the `ref`.", - "type": "boolean" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1561592,132 +1562122,6 @@ "avatar_url" ] }, - "forced": { - "description": "Whether this push was a force push of the `ref`.", - "type": "boolean" - }, - "head_commit": { - "title": "Commit", - "type": [ - "object", - "null" - ], - "properties": { - "added": { - "description": "An array of files added in the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "distinct": { - "description": "Whether this commit is distinct from any that have been pushed before.", - "type": "boolean" - }, - "id": { - "type": "string" - }, - "message": { - "description": "The commit message.", - "type": "string" - }, - "modified": { - "description": "An array of files modified by the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "removed": { - "description": "An array of files removed in the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "timestamp": { - "description": "The ISO 8601 timestamp of the commit.", - "type": "string", - "format": "date-time" - }, - "tree_id": { - "type": "string" - }, - "url": { - "description": "URL that points to the commit API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "tree_id", - "distinct", - "message", - "timestamp", - "url", - "author", - "committer" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1561743,6 +1562147,10 @@ "node_id" ] }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1561842,365 +1562250,146 @@ "description" ] }, - "pusher": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "ref": { - "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.", - "type": "string" - }, - "repository": { - "title": "Repository", - "description": "A git repository", + "pull_request": { + "title": "Pull Request", "type": "object", "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "custom_properties": { + "_links": { "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 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "type": "boolean", - "default": true - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], "properties": { - "key": { - "type": "string" + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "name": { - "type": "string" + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "node_id": { - "type": "string" + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "spdx_id": { - "type": "string" + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] } }, "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" ] }, - "master_branch": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { + "active_lock_reason": { "type": [ "string", "null" ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, - "open_issues_count": { + "additions": { "type": "integer" }, - "organization": { - "type": "string" - }, - "owner": { + "assignee": { "title": "User", "type": [ "object", @@ -1562299,864 +1562488,181 @@ "id" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { + "assignees": { "type": "array", "items": { - "type": "string" + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] } }, - "trees_url": { - "type": "string", - "format": "uri-template" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "visibility": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", "enum": [ - "public", - "private", - "internal" - ] - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private", - "owner", - "html_url", - "description", - "fork", - "url", - "forks_url", - "keys_url", - "collaborators_url", - "teams_url", - "hooks_url", - "issue_events_url", - "events_url", - "assignees_url", - "branches_url", - "tags_url", - "blobs_url", - "git_tags_url", - "git_refs_url", - "trees_url", - "statuses_url", - "languages_url", - "stargazers_url", - "contributors_url", - "subscribers_url", - "subscription_url", - "commits_url", - "git_commits_url", - "comments_url", - "issue_comment_url", - "contents_url", - "compare_url", - "merges_url", - "archive_url", - "downloads_url", - "issues_url", - "pulls_url", - "milestones_url", - "notifications_url", - "labels_url", - "releases_url", - "deployments_url", - "created_at", - "updated_at", - "pushed_at", - "git_url", - "ssh_url", - "clone_url", - "svn_url", - "homepage", - "size", - "stargazers_count", - "watchers_count", - "language", - "has_issues", - "has_projects", - "has_downloads", - "has_wiki", - "has_pages", - "has_discussions", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] - }, - "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": [ - "ref", - "before", - "after", - "created", - "deleted", - "forced", - "base_ref", - "compare", - "commits", - "head_commit", - "repository", - "pusher" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "push", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "registry-package-published": { - "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" - }, - "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": "registry_package", - "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": { - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "published" - ] - }, - "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" - ] - }, - "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" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "description": { + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", "type": [ - "string", + "object", "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" - ] - }, - "registry_package": { - "type": "object", - "properties": { - "created_at": { - "type": [ - "string", - "null" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "owner": { - "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" - }, - "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" + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] }, - "url": { + "commit_title": { + "description": "Title for the merge commit message.", "type": "string" }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" - ] - }, - "package_type": { - "type": "string" - }, - "package_version": { - "type": [ - "object", - "null" - ], - "properties": { - "author": { - "type": "object", + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1563164,32 +1562670,46 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" @@ -1563197,469 +1562717,415 @@ }, "required": [ "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" + "id" ] }, - "body": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - "body_html": { + "ref": { "type": "string" }, - "container_metadata": { + "repo": { + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { - "labels": { - "type": [ - "object", - "null" - ] + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false }, - "manifest": { - "type": [ - "object", - "null" - ] + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" }, - "tag": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - } - }, - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "docker_metadata": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "installation_command": { - "type": "string" - }, - "manifest": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - }, - "name": { - "type": "string" - }, - "npm_metadata": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true }, - "version": { - "type": "string" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true }, - "npm_user": { - "type": "string" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true }, - "author": { + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { "oneOf": [ { - "type": "string" + "type": "integer" }, { - "type": "object" + "type": "string", + "format": "date-time" } - ], - "type": [ - "null", - "string", - "object" ] }, - "bugs": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { "type": [ - "null", "string", - "object" + "null" ] }, - "dependencies": { - "type": "object" + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" }, - "dev_dependencies": { - "type": "object" + "downloads_url": { + "type": "string", + "format": "uri" }, - "peer_dependencies": { - "type": "object" + "events_url": { + "type": "string", + "format": "uri" }, - "optional_dependencies": { - "type": "object" + "fork": { + "type": "boolean" }, - "description": { - "type": "string" + "forks": { + "type": "integer" }, - "dist": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], - "type": [ - "null", - "string", - "object" - ] + "forks_count": { + "type": "integer" }, - "git_head": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri" }, - "homepage": { + "full_name": { "type": "string" }, - "license": { - "type": "string" + "git_commits_url": { + "type": "string", + "format": "uri-template" }, - "main": { - "type": "string" + "git_refs_url": { + "type": "string", + "format": "uri-template" }, - "repository": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { "type": [ - "null", "string", - "object" + "null" ] }, - "scripts": { - "type": "object" - }, - "id": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri" }, - "node_version": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "npm_version": { - "type": "string" + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" }, - "has_shrinkwrap": { + "is_template": { "type": "boolean" }, - "maintainers": { - "type": "array", - "items": { - "type": "string" - } + "issue_comment_url": { + "type": "string", + "format": "uri-template" }, - "contributors": { - "type": "array", - "items": { - "type": "string" - } + "issue_events_url": { + "type": "string", + "format": "uri-template" }, - "engines": { - "type": "object" + "issues_url": { + "type": "string", + "format": "uri-template" }, - "keywords": { - "type": "array", - "items": { - "type": "string" - } + "keys_url": { + "type": "string", + "format": "uri-template" }, - "files": { - "type": "array", - "items": { - "type": "string" - } + "labels_url": { + "type": "string", + "format": "uri-template" }, - "bin": { - "type": "object" + "language": { + "type": [ + "string", + "null" + ] }, - "man": { - "type": "object" + "languages_url": { + "type": "string", + "format": "uri" }, - "directories": { - "oneOf": [ - { + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { "type": "string" }, - { - "type": "object" + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } - ], - "type": [ - "null", - "string", - "object" + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" ] }, - "os": { - "type": "array", - "items": { - "type": "string" - } + "master_branch": { + "type": "string" }, - "cpu": { - "type": "array", - "items": { - "type": "string" - } + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] }, - "readme": { + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", "type": "string" }, - "installation_command": { + "node_id": { "type": "string" }, - "release_id": { + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { "type": "integer" }, - "commit_oid": { - "type": "string" + "open_issues_count": { + "type": "integer" }, - "published_via_actions": { - "type": "boolean" + "organization": { + "type": "string" }, - "deleted_by_id": { - "type": "integer" - } - } - }, - "nuget_metadata": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "object", - "integer" - ] - }, - "name": { - "type": "string" - }, - "value": { - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "branch": { - "type": "string" - }, - "commit": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - ] - } - } - } - }, - "package_files": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "md5": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "sha1": { - "type": [ - "string", - "null" - ] - }, - "sha256": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "state": { - "type": [ - "string", - "null" - ] - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "download_url", - "id", - "name", - "sha256", - "sha1", - "md5", - "content_type", - "state", - "size", - "created_at", - "updated_at" - ] - } - }, - "package_url": { - "type": "string" - }, - "prerelease": { - "type": "boolean" - }, - "release": { - "type": "object", - "properties": { - "author": { - "type": "object", + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1563667,510 +1563133,1357 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, - "created_at": { - "type": "string" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] }, - "draft": { + "private": { + "description": "Whether the repository is private or public.", "type": "boolean" }, - "html_url": { + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { "type": "string" }, - "id": { + "stargazers": { "type": "integer" }, - "name": { + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" ] }, - "prerelease": { - "type": "boolean" + "events_url": { + "type": "string", + "format": "uri-template" }, - "published_at": { + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "tag_name": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { "type": "string" }, - "target_commitish": { + "name": { + "type": "string" + }, + "node_id": { "type": "string" }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { "type": "string" } - } - }, - "rubygems_metadata": { - "type": "array", - "items": { - "title": "Ruby Gems metadata", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "readme": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "version_info": { - "type": "object", - "properties": { - "version": { - "type": "string" - } - } - }, - "platform": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repo": { - "type": "string" - }, - "dependencies": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "commit_oid": { - "type": "string" - } - } - } - }, - "summary": { - "type": "string" - }, - "tag_name": { - "type": "string" - }, - "target_commitish": { - "type": "string" - }, - "target_oid": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "version": { - "type": "string" + }, + "required": [ + "login", + "id" + ] } }, "required": [ - "id", - "version", - "name", - "description", - "summary", - "html_url", - "metadata", - "package_files", - "installation_command", - "package_url" + "label", + "ref", + "sha", + "user", + "repo" ] }, - "registry": { + "body": { "type": [ - "object", + "string", "null" - ], - "properties": { - "about_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - }, - "vendor": { - "type": "string" - } - } + ] }, - "updated_at": { + "changed_files": { + "type": "integer" + }, + "closed_at": { "type": [ "string", "null" - ] - } - }, - "required": [ - "id", - "name", - "namespace", - "description", - "ecosystem", - "package_type", - "html_url", - "created_at", - "updated_at", - "owner", - "package_version", - "registry" - ] - }, - "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 - ] + ], + "format": "date-time" }, - "node_id": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "format": "uri" }, - "name": { - "description": "The name of the repository.", + "commits": { + "type": "integer" + }, + "commits_url": { "type": "string", - "examples": [ - "Team Environment" - ] + "format": "uri" }, - "full_name": { + "created_at": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "format": "date-time" }, - "license": { - "anyOf": [ - { - "type": "null" + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], "properties": { - "key": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { "type": "string", - "examples": [ - "mit" - ] + "format": "uri-template" }, - "name": { + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { "type": "string", - "examples": [ - "MIT License" + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } ] }, - "url": { + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" ] }, - "spdx_id": { + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { "type": [ "string", "null" - ], - "examples": [ - "MIT" ] }, - "node_id": { + "hooks_url": { "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "format": "uri" }, "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": { + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { "type": [ "string", "null" ] }, - "email": { + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", "type": [ - "string", + "object", "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" ] }, - "login": { + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", - "examples": [ - "octocat" + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" ] }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" ] }, - "node_id": { + "merges_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri" }, - "avatar_url": { + "milestones_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, - "gravatar_id": { + "mirror_url": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "format": "uri" }, - "url": { + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" ] }, - "followers_url": { + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" ] }, - "following_url": { + "releases_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" ] }, - "gists_url": { + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" ] }, - "starred_url": { + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" ] }, - "subscriptions_url": { + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "statuses_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" ] }, - "repos_url": { + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" ] }, "events_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "uri" }, - "type": { + "repos_url": { "type": "string", - "examples": [ - "User" - ] + "format": "uri" }, "site_admin": { "type": "boolean" }, - "starred_at": { + "starred_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri-template" }, - "user_view_type": { + "subscriptions_url": { "type": "string", - "examples": [ - "public" + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "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" + "id" ] } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" ] }, - "forks": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" }, "email": { "type": [ @@ -1564178,220 +1564491,1379 @@ "null" ] }, - "login": { + "events_url": { "type": "string", - "examples": [ - "octocat" - ] + "format": "uri-template" }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "following_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "format": "uri" }, - "following_url": { + "received_events_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "format": "uri" }, - "gists_url": { + "repos_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "format": "uri" + }, + "site_admin": { + "type": "boolean" }, "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "format": "uri-template" }, "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "repos_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "description": { + "type": [ + "string", + "null" ] }, - "type": { + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { "type": "string", - "examples": [ - "User" - ] + "format": "uri" }, - "site_admin": { - "type": "boolean" + "id": { + "type": "integer" }, - "starred_at": { + "labels_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" }, - "user_view_type": { + "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", - "examples": [ - "public" + "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": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "url", "html_url", + "labels_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "node_id": { + "type": "string" }, - "html_url": { + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "format": "uri" }, - "description": { + "rebaseable": { "type": [ - "string", + "boolean", "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", + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] @@ -1565540,7 +1567012,9 @@ }, "required": [ "action", - "registry_package", + "number", + "pull_request", + "repository", "sender" ] } @@ -1565555,7 +1567029,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -1565564,13 +1567038,12 @@ } } }, - "registry-package-updated": { + "push": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1565592,7 +1567065,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "registry_package", + "example": "push", "schema": { "type": "string" } @@ -1565635,14 +1567108,158 @@ "content": { "application/json": { "schema": { + "title": "push event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "updated" + "after": { + "description": "The SHA of the most recent commit on `ref` after the push.", + "type": "string" + }, + "base_ref": { + "type": [ + "string", + "null" ] }, + "before": { + "description": "The SHA of the most recent commit on `ref` before the push.", + "type": "string" + }, + "commits": { + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits.", + "type": "array", + "items": { + "title": "Commit", + "type": "object", + "properties": { + "added": { + "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + } + }, + "compare": { + "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.", + "type": "string" + }, + "created": { + "description": "Whether this push created the `ref`.", + "type": "boolean" + }, + "deleted": { + "description": "Whether this push deleted the `ref`.", + "type": "boolean" + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1565733,6 +1567350,132 @@ "avatar_url" ] }, + "forced": { + "description": "Whether this push was a force push of the `ref`.", + "type": "boolean" + }, + "head_commit": { + "title": "Commit", + "type": [ + "object", + "null" + ], + "properties": { + "added": { + "description": "An array of files added in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1565857,55 +1567600,406 @@ "description" ] }, - "registry_package": { + "pusher": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "ref": { + "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.", + "type": "string" + }, + "repository": { + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "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 + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string" }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, "description": { "type": [ + "string", "null" ] }, - "ecosystem": { + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { "type": "string" }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { - "type": "integer" + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, "name": { + "description": "The name of the repository.", "type": "string" }, - "namespace": { + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { "type": "string" }, "owner": { - "type": "object", + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1565913,32 +1568007,46 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" @@ -1565946,252 +1568054,1376 @@ }, "required": [ "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" + "id" ] }, - "package_type": { - "type": "string" - }, - "package_version": { + "permissions": { "type": "object", "properties": { - "author": { - "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" - }, - "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": [ - "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" - ] - }, - "body": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "docker_metadata": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ], - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "draft": { + "admin": { "type": "boolean" }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "installation_command": { - "type": "string" - }, - "manifest": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - }, - "name": { - "type": "string" + "maintain": { + "type": "boolean" }, - "package_files": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "md5": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "sha1": { - "type": [ - "string", - "null" - ] - }, - "sha256": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } + "pull": { + "type": "boolean" }, - "package_url": { - "type": "string" + "push": { + "type": "boolean" }, - "prerelease": { + "triage": { "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" }, - "release": { - "type": "object", - "properties": { - "author": { - "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" - }, - "login": { - "type": "string" + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "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": [ + "ref", + "before", + "after", + "created", + "deleted", + "forced", + "base_ref", + "compare", + "commits", + "head_commit", + "repository", + "pusher" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "push", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "registry-package-published": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + }, + "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": "registry_package", + "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": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" + ] + }, + "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" + ] + }, + "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" + ] + }, + "registry_package": { + "type": "object", + "properties": { + "created_at": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { + "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" + }, + "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": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "package_type": { + "type": "string" + }, + "package_version": { + "type": [ + "object", + "null" + ], + "properties": { + "author": { + "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" + }, + "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": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "body": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "body_html": { + "type": "string" + }, + "container_metadata": { + "type": "object", + "properties": { + "labels": { + "type": [ + "object", + "null" + ] + }, + "manifest": { + "type": [ + "object", + "null" + ] + }, + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "npm_metadata": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "npm_user": { + "type": "string" + }, + "author": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "bugs": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "dependencies": { + "type": "object" + }, + "dev_dependencies": { + "type": "object" + }, + "peer_dependencies": { + "type": "object" + }, + "optional_dependencies": { + "type": "object" + }, + "description": { + "type": "string" + }, + "dist": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "git_head": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "license": { + "type": "string" + }, + "main": { + "type": "string" + }, + "repository": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "scripts": { + "type": "object" + }, + "id": { + "type": "string" + }, + "node_version": { + "type": "string" + }, + "npm_version": { + "type": "string" + }, + "has_shrinkwrap": { + "type": "boolean" + }, + "maintainers": { + "type": "array", + "items": { + "type": "string" + } + }, + "contributors": { + "type": "array", + "items": { + "type": "string" + } + }, + "engines": { + "type": "object" + }, + "keywords": { + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + }, + "bin": { + "type": "object" + }, + "man": { + "type": "object" + }, + "directories": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "os": { + "type": "array", + "items": { + "type": "string" + } + }, + "cpu": { + "type": "array", + "items": { + "type": "string" + } + }, + "readme": { + "type": "string" + }, + "installation_command": { + "type": "string" + }, + "release_id": { + "type": "integer" + }, + "commit_oid": { + "type": "string" + }, + "published_via_actions": { + "type": "boolean" + }, + "deleted_by_id": { + "type": "integer" + } + } + }, + "nuget_metadata": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "object", + "integer" + ] + }, + "name": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "commit": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + ] + } + } + } + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "sha1": { + "type": [ + "string", + "null" + ] + }, + "sha256": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "state": { + "type": [ + "string", + "null" + ] + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "download_url", + "id", + "name", + "sha256", + "sha1", + "md5", + "content_type", + "state", + "size", + "created_at", + "updated_at" + ] + } + }, + "package_url": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "release": { + "type": "object", + "properties": { + "author": { + "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" + }, + "login": { + "type": "string" }, "node_id": { "type": "string" @@ -1566223,27 +1569455,7 @@ "user_view_type": { "type": "string" } - }, - "required": [ - "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" - ] + } }, "created_at": { "type": "string" @@ -1566258,7 +1569470,10 @@ "type": "integer" }, "name": { - "type": "string" + "type": [ + "string", + "null" + ] }, "prerelease": { "type": "boolean" @@ -1566275,20 +1569490,7 @@ "url": { "type": "string" } - }, - "required": [ - "url", - "html_url", - "id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "created_at", - "published_at" - ] + } }, "rubygems_metadata": { "type": "array", @@ -1566368,16 +1569570,9 @@ "name", "description", "summary", - "body", - "body_html", "html_url", - "target_commitish", - "target_oid", - "created_at", - "updated_at", "metadata", "package_files", - "author", "installation_command", "package_url" ] @@ -1566386,10 +1569581,30 @@ "type": [ "object", "null" - ] + ], + "properties": { + "about_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "vendor": { + "type": "string" + } + } }, "updated_at": { - "type": "string" + "type": [ + "string", + "null" + ] } }, "required": [ @@ -1568107,13 +1571322,13 @@ } } }, - "release-created": { + "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -1568135,7 +1571350,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -1568178,13 +1571393,12 @@ "content": { "application/json": { "schema": { - "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "updated" ] }, "enterprise": { @@ -1568401,232 +1571615,55 @@ "description" ] }, - "release": { - "title": "Release", - "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "registry_package": { "type": "object", "properties": { - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "download_count": { - "type": "integer" - }, - "id": { - "type": "integer" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ] - } - }, - "assets_url": { - "type": "string", - "format": "uri" + "created_at": { + "type": "string" }, - "author": { - "title": "User", + "description": { "type": [ - "object", "null" - ], + ] + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { + "type": "object", "properties": { "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] + "type": "string" }, "events_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "followers_url": { - "type": "string", - "format": "uri" + "type": "string" }, "following_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gists_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" @@ -1568634,46 +1571671,32 @@ "login": { "type": "string" }, - "name": { - "type": "string" - }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string", - "format": "uri" + "type": "string" }, "received_events_url": { - "type": "string", - "format": "uri" + "type": "string" }, "repos_url": { - "type": "string", - "format": "uri" + "type": "string" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "subscriptions_url": { - "type": "string", - "format": "uri" + "type": "string" }, "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "type": "string" }, "url": { - "type": "string", - "format": "uri" + "type": "string" }, "user_view_type": { "type": "string" @@ -1568681,353 +1571704,649 @@ }, "required": [ "login", - "id" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri" - }, - "draft": { - "description": "Whether the release is a draft or published", - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" ] }, - "node_id": { + "package_type": { "type": "string" }, - "prerelease": { - "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "reactions": { - "title": "Reactions", + "package_version": { "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" - ] - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, - "url": { - "type": "string", - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "assets_url", - "upload_url", - "html_url", - "id", - "node_id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "immutable", - "created_at", - "published_at", - "assets", - "tarball_url", - "updated_at", - "zipball_url", - "body" - ] - }, - "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", + "author": { "type": "object", "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] + "avatar_url": { + "type": "string" }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] + "events_url": { + "type": "string" }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] + "followers_url": { + "type": "string" }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "following_url": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" }, "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" - ] + "type": "string" }, - "email": { - "type": [ - "string", - "null" - ] + "id": { + "type": "integer" }, "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "type": "string" }, "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "organizations_url": { + "type": "string" }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "received_events_url": { + "type": "string" }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "repos_url": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "site_admin": { + "type": "boolean" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "starred_url": { + "type": "string" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "subscriptions_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ], + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "sha1": { + "type": [ + "string", + "null" + ] + }, + "sha256": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "package_url": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "release": { + "type": "object", + "properties": { + "author": { + "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" + }, + "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": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "required": [ + "url", + "html_url", + "id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "created_at", + "published_at" + ] + }, + "rubygems_metadata": { + "type": "array", + "items": { + "title": "Ruby Gems metadata", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "readme": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "version_info": { + "type": "object", + "properties": { + "version": { + "type": "string" + } + } + }, + "platform": { + "type": "string" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repo": { + "type": "string" + }, + "dependencies": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "commit_oid": { + "type": "string" + } + } + } + }, + "summary": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "target_oid": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "required": [ + "id", + "version", + "name", + "description", + "summary", + "body", + "body_html", + "html_url", + "target_commitish", + "target_oid", + "created_at", + "updated_at", + "metadata", + "package_files", + "author", + "installation_command", + "package_url" + ] + }, + "registry": { + "type": [ + "object", + "null" + ] + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", + "created_at", + "updated_at", + "owner", + "package_version", + "registry" + ] + }, + "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": { @@ -1570522,8 +1573841,7 @@ }, "required": [ "action", - "release", - "repository", + "registry_package", "sender" ] } @@ -1570538,7 +1573856,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -1570547,11 +1573865,11 @@ } } }, - "release-deleted": { + "release-created": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1570618,13 +1573936,13 @@ "content": { "application/json": { "schema": { - "title": "release deleted event", + "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "created" ] }, "enterprise": { @@ -1572987,11 +1576305,11 @@ } } }, - "release-edited": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "description": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1573058,68 +1576376,15 @@ "content": { "application/json": { "schema": { - "title": "release edited event", + "title": "release deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "deleted" ] }, - "changes": { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "name": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the name if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "tag_name": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the tag_name if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "make_latest": { - "type": "object", - "properties": { - "to": { - "description": "Whether this release was explicitly `edited` to be the latest.", - "type": "boolean" - } - }, - "required": [ - "to" - ] - } - } - }, "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).\"", @@ -1575455,9 +1578720,9 @@ }, "required": [ "action", - "changes", "release", - "repository" + "repository", + "sender" ] } } @@ -1575480,11 +1578745,11 @@ } } }, - "release-prereleased": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1575551,15 +1578816,68 @@ "content": { "application/json": { "schema": { - "title": "release prereleased event", + "title": "release edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "prereleased" + "edited" ] }, + "changes": { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "tag_name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the tag_name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "make_latest": { + "type": "object", + "properties": { + "to": { + "description": "Whether this release was explicitly `edited` to be the latest.", + "type": "boolean" + } + }, + "required": [ + "to" + ] + } + } + }, "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).\"", @@ -1575778,53 +1579096,13 @@ "title": "Release", "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", "type": "object", - "required": [ - "assets", - "assets_url", - "author", - "body", - "created_at", - "draft", - "html_url", - "id", - "immutable", - "name", - "node_id", - "prerelease", - "published_at", - "tag_name", - "tarball_url", - "target_commitish", - "updated_at", - "upload_url", - "url", - "zipball_url" - ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": [ - "object", - "null" - ], - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ], + "type": "object", "properties": { "browser_download_url": { "type": "string", @@ -1575882,10 +1579160,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1575970,13 +1579244,32 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "login", + "id" + ] }, "url": { "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "digest", + "content_type", + "size", + "download_count", + "created_at", + "updated_at" + ] } }, "assets_url": { @@ -1575989,10 +1579282,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1576080,7 +1579369,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": [ @@ -1576095,6 +1579388,13 @@ ], "format": "date-time" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1576125,10 +1579425,7 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean", - "enum": [ - true - ] + "type": "boolean" }, "published_at": { "type": [ @@ -1576140,18 +1579437,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1576184,7 +1579469,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "tag_name": { "description": "The name of the tag.", @@ -1576205,13 +1579502,6 @@ "type": "string", "format": "uri-template" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "url": { "type": "string", "format": "uri" @@ -1576223,7 +1579513,29 @@ ], "format": "uri" } - } + }, + "required": [ + "url", + "assets_url", + "upload_url", + "html_url", + "id", + "node_id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "immutable", + "created_at", + "published_at", + "assets", + "tarball_url", + "updated_at", + "zipball_url", + "body" + ] }, "repository": { "title": "Repository", @@ -1577901,6 +1581213,7 @@ }, "required": [ "action", + "changes", "release", "repository" ] @@ -1577925,11 +1581238,11 @@ } } }, - "release-published": { + "release-prereleased": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1577996,13 +1581309,13 @@ "content": { "application/json": { "schema": { - "title": "release published event", + "title": "release prereleased event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "prereleased" ] }, "enterprise": { @@ -1578232,10 +1581545,10 @@ "draft", "html_url", "id", + "immutable", "name", "node_id", "prerelease", - "immutable", "published_at", "tag_name", "tarball_url", @@ -1578263,9 +1581576,9 @@ "name", "label", "state", + "digest", "content_type", "size", - "digest", "download_count", "created_at", "updated_at" @@ -1578570,7 +1581883,10 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" + "type": "boolean", + "enum": [ + true + ] }, "published_at": { "type": [ @@ -1578643,6 +1581959,10 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, "updated_at": { "type": [ "string", @@ -1578650,10 +1581970,6 @@ ], "format": "date-time" }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, "url": { "type": "string", "format": "uri" @@ -1580367,11 +1583683,11 @@ } } }, - "release-released": { + "release-published": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1580438,13 +1583754,13 @@ "content": { "application/json": { "schema": { - "title": "release released event", + "title": "release published event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "released" + "published" ] }, "enterprise": { @@ -1580665,13 +1583981,53 @@ "title": "Release", "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", "type": "object", + "required": [ + "assets", + "assets_url", + "author", + "body", + "created_at", + "draft", + "html_url", + "id", + "name", + "node_id", + "prerelease", + "immutable", + "published_at", + "tag_name", + "tarball_url", + "target_commitish", + "updated_at", + "upload_url", + "url", + "zipball_url" + ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": "object", + "type": [ + "object", + "null" + ], + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], "properties": { "browser_download_url": { "type": "string", @@ -1580729,6 +1584085,10 @@ "object", "null" ], + "required": [ + "login", + "id" + ], "properties": { "avatar_url": { "type": "string", @@ -1580813,32 +1584173,13 @@ "type": "string", "format": "uri" } - }, - "required": [ - "login", - "id" - ] + } }, "url": { "type": "string", "format": "uri" } - }, - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ] + } } }, "assets_url": { @@ -1580851,6 +1584192,10 @@ "object", "null" ], + "required": [ + "login", + "id" + ], "properties": { "avatar_url": { "type": "string", @@ -1580938,11 +1584283,7 @@ "user_view_type": { "type": "string" } - }, - "required": [ - "login", - "id" - ] + } }, "body": { "type": [ @@ -1580957,13 +1584298,6 @@ ], "format": "date-time" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "discussion_url": { "type": "string", "format": "uri" @@ -1581006,6 +1584340,18 @@ "reactions": { "title": "Reactions", "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], "properties": { "+1": { "type": "integer" @@ -1581038,19 +1584384,7 @@ "type": "string", "format": "uri" } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + } }, "tag_name": { "description": "The name of the tag.", @@ -1581067,6 +1584401,13 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "upload_url": { "type": "string", "format": "uri-template" @@ -1581082,29 +1584423,7 @@ ], "format": "uri" } - }, - "required": [ - "url", - "assets_url", - "upload_url", - "html_url", - "id", - "node_id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "immutable", - "created_at", - "published_at", - "assets", - "tarball_url", - "updated_at", - "zipball_url", - "body" - ] + } }, "repository": { "title": "Repository", @@ -1582806,11 +1586125,11 @@ } } }, - "release-unpublished": { + "release-released": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release or pre-release was unpublished.", - "operationId": "release/unpublished", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1582877,13 +1586196,13 @@ "content": { "application/json": { "schema": { - "title": "release unpublished event", + "title": "release released event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unpublished" + "released" ] }, "enterprise": { @@ -1583104,53 +1586423,13 @@ "title": "Release", "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", "type": "object", - "required": [ - "assets", - "assets_url", - "author", - "body", - "created_at", - "draft", - "html_url", - "id", - "name", - "node_id", - "prerelease", - "immutable", - "published_at", - "tag_name", - "tarball_url", - "target_commitish", - "updated_at", - "upload_url", - "url", - "zipball_url" - ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": [ - "object", - "null" - ], - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "content_type", - "size", - "digest", - "download_count", - "created_at", - "updated_at" - ], + "type": "object", "properties": { "browser_download_url": { "type": "string", @@ -1583208,10 +1586487,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1583296,13 +1586571,32 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "login", + "id" + ] }, "url": { "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "digest", + "content_type", + "size", + "download_count", + "created_at", + "updated_at" + ] } }, "assets_url": { @@ -1583315,10 +1586609,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1583406,7 +1586696,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": [ @@ -1583421,6 +1586715,13 @@ ], "format": "date-time" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1583463,18 +1586764,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1583507,7 +1586796,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "tag_name": { "description": "The name of the tag.", @@ -1583524,13 +1586825,6 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "upload_url": { "type": "string", "format": "uri-template" @@ -1583546,7 +1586840,29 @@ ], "format": "uri" } - } + }, + "required": [ + "url", + "assets_url", + "upload_url", + "html_url", + "id", + "node_id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "immutable", + "created_at", + "published_at", + "assets", + "tarball_url", + "updated_at", + "zipball_url", + "body" + ] }, "repository": { "title": "Repository", @@ -1585248,13 +1588564,13 @@ } } }, - "repository-advisory-published": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A repository security advisory was published.", - "operationId": "repository-advisory/published", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1585276,7 +1588592,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -1585319,13 +1588635,2455 @@ "content": { "application/json": { "schema": { - "title": "Repository advisory published event", + "title": "release unpublished event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "unpublished" + ] + }, + "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" + ] + }, + "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" + ] + }, + "release": { + "title": "Release", + "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "type": "object", + "required": [ + "assets", + "assets_url", + "author", + "body", + "created_at", + "draft", + "html_url", + "id", + "name", + "node_id", + "prerelease", + "immutable", + "published_at", + "tag_name", + "tarball_url", + "target_commitish", + "updated_at", + "upload_url", + "url", + "zipball_url" + ], + "properties": { + "assets": { + "type": "array", + "items": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": [ + "object", + "null" + ], + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], + "properties": { + "browser_download_url": { + "type": "string", + "format": "uri" + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "download_count": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "label": { + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": [ + "string", + "null" + ] + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "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" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "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" + } + } + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Whether the release is a draft or published", + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "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" + } + } + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string" + }, + "tarball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + } + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "release", + "repository" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-advisory-published": { + "post": { + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_advisory", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Repository advisory published event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" ] }, "enterprise": { @@ -1613741,6 +1619499,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1617074,6 +1622875,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1620407,6 +1626251,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1621497,57 +1627384,31 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", "type": "object", "properties": { "id": { "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." + "description": "ID of the actor that can dismiss reviews." }, "type": { "type": "string", - "description": "The type of the reviewer", + "description": "The type of the actor", "enum": [ - "Team" + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" ] } }, @@ -1621557,864 +1627418,976 @@ ] } }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } - }, - { - "title": "license_compliance_scanning", - "description": "Enforce any added or changed dependencies to comply with the organization's license policy.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "license_compliance_scanning" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - } - ] - } - }, - "deleted": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, + { + "title": "license_compliance_scanning", + "description": "Enforce any added or changed dependencies to comply with the organization's license policy.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "license_compliance_scanning" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + } + ] + } + }, + "deleted": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" ] }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1623336,6 +1629309,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1624315,206 +1630331,4370 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "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" + ] + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "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" + ] + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-vulnerability-alert-create": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_vulnerability_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { - "type": "object", + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "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" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "auto_dismissed", + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1626406,7 +1636586,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1626422,23 +1636602,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1626460,7 +1636638,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -1626503,15 +1636681,199 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": [ + "string", + "null" + ] + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "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" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1628402,6 +1638764,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1628417,21 +1638780,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1628498,13 +1638859,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1630594,11 +1640955,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1630665,13 +1641026,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1630682,9 +1641043,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1630704,12 +1641062,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": [ - "string", - "null" - ] - }, "dismiss_reason": { "type": "string" }, @@ -1630809,9 +1641161,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1630853,7 +1641202,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1632772,13 +1643122,13 @@ } } }, - "repository-vulnerability-alert-reopen": { + "secret-scanning-alert-assigned": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1632800,7 +1643150,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1632843,187 +1643193,1252 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert reopen event", + "title": "secret_scanning_alert assigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopen" + "assigned" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "email": { - "type": [ - "string", - "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" ] + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" + { + "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" + ] + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" }, - "subscriptions_url": { - "type": "string", - "format": "uri" + { + "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" + ] + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "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" ] + } + ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "anyOf": [ + { + "type": "null" }, - "url": { - "type": "string", - "format": "uri" + { + "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" + ] } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] } + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "external_identifier": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "external_reference": { + "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" ], - "format": "uri" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "fix_reason": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "fixed_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "fixed_in": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "ghsa_id": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "id": { - "type": "integer" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "number": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "severity": { - "type": "string" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "state": { + "repos_url": { "type": "string", - "enum": [ - "auto_dismissed", - "open" + "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" + ] }, "enterprise": { "title": "Enterprise", @@ -1634916,8 +1646331,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1634931,21 +1646345,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1634967,7 +1646382,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1635010,185 +1646425,1082 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "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" ] - }, - "url": { - "type": "string", - "format": "uri" } - } + ] }, - "external_identifier": { - "type": "string" + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." }, - "external_reference": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { "type": [ "string", "null" ], - "format": "uri" + "description": "The provider of the secret that was detected." }, - "fix_reason": { - "type": "string" + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." }, - "fixed_at": { + "validity": { "type": "string", - "format": "date-time" + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "fixed_in": { - "type": "string" + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." }, - "ghsa_id": { - "type": "string" + "push_protection_bypassed_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" + ] + } + ] }, - "id": { - "type": "integer" + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, - "node_id": { - "type": "string" + "push_protection_bypass_request_reviewer": { + "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" + ] + } + ] }, - "number": { - "type": "integer" + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "severity": { - "type": "string" + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "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" + ] + } ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1637083,8 +1649395,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1637098,21 +1649409,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-assigned": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was assigned.", - "operationId": "secret-scanning-alert/assigned", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1637134,7 +1649446,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "secret_scanning_alert_location", "schema": { "type": "string" } @@ -1637177,13 +1649489,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert assigned event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "assigned" + "created" ] }, "alert": { @@ -1638231,291 +1650543,475 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", + "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": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "The ID of the installation.", "type": "integer", - "format": "int64", "examples": [ 1 ] }, "node_id": { + "description": "The global node ID of the installation.", "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" + "MDQ6VXNlcjU4MzIzMQ==" ] } }, "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" + "node_id" ] }, - "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).\"", + "location": { "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": { "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" ], - "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", + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", "examples": [ - 1 + "commit" ] }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "examples": [ + "/example/secrets.txt" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": [ + "/example/Home.md" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082" + ] + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussion-4566270" + ] + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + ] + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } ] } - }, - "required": [ - "id", - "node_id" - ] + } }, "organization": { "title": "Organization Simple", @@ -1640291,10 +1652787,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1640306,8 +1652977,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1640316,11 +1652988,11 @@ } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-metadata-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "description": "Metadata was created for a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1640387,13 +1653059,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "secret_scanning_alert metadata created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_created" ] }, "alert": { @@ -1641042,405 +1653714,427 @@ } ] }, - "push_protection_bypass_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when reviewing a push protection bypass." - }, - "push_protection_bypass_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when requesting a push protection bypass." - }, - "push_protection_bypass_request_html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was publicly leaked." - }, - "multi_repo": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or business." - }, - "assigned_to": { - "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" - ] - } + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "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" + ] + } + ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." }, - "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" - ] - } - ] - }, - "closure_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request author." - }, - "closure_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request reviewer." - }, - "closure_request_reviewer": { - "anyOf": [ - { - "type": "null" + "value": { + "type": "string", + "description": "The metadata value." + } }, - { - "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": [ + "key", + "value" + ] + } } } }, @@ -1643347,7 +1656041,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -1643358,13 +1656051,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-metadata-removed": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "Metadata was removed from a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1643386,7 +1656079,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert_location", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1643429,13 +1656122,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert metadata removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_removed" ] }, "alert": { @@ -1644483,453 +1657176,145 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, - "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).\"", + "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": "The ID of the installation.", + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { - "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "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" + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, - "location": { + "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": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "commit" + 1 ] }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/example/secrets.txt" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL to get the associated commit resource.", - "examples": [ - "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "examples": [ - "/example/Home.md" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1" - ] - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1" - ] - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" - ] - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082" - ] - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussion-4566270" - ] - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846" - ] - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846" - ] - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" - ] - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request review where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" - ] - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request review comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" ] } - } + }, + "required": [ + "id", + "node_id" + ] }, "organization": { "title": "Organization Simple", @@ -1646705,185 +1659090,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1646894,10 +1659104,8 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1648031,6 +1660239,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1650885,194 +1663115,216 @@ } ] }, - "closure_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request author." - }, - "closure_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request reviewer." - }, - "closure_request_reviewer": { - "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" - ] - } + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." }, - "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" - ] - } - ] + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1654115,6 +1666367,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1657157,6 +1669431,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1660367,6 +1672663,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index c89d88774f..adcc093c9e 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 @@ -1080,7 +1080,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &668 + - &670 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -14524,7 +14524,7 @@ paths: properties: action: type: string - discussion: &761 + discussion: &763 title: Discussion description: A Discussion in a repository. type: object @@ -15310,7 +15310,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &679 + sub_issues_summary: &681 title: Sub-issues Summary type: object properties: @@ -15440,7 +15440,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &680 + issue_dependencies_summary: &682 title: Issue Dependencies Summary type: object properties: @@ -16961,7 +16961,7 @@ paths: url: type: string format: uri - user: &688 + user: &690 title: Public User description: Public User type: object @@ -22981,7 +22981,7 @@ paths: parameters: - *74 - *116 - - &739 + - &741 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -23093,7 +23093,7 @@ paths: - *116 - *117 - *118 - - &740 + - &742 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -23101,7 +23101,7 @@ paths: schema: type: string - *121 - - &741 + - &743 name: sku description: The SKU to query for usage. in: query @@ -30785,12 +30785,12 @@ paths: required: - subject_digests examples: - default: &720 + default: &722 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &721 + withPredicateType: &723 value: subject_digests: - sha256:abc123 @@ -30849,7 +30849,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &722 + default: &724 value: attestations_subject_digests: - sha256:abc: @@ -43068,7 +43068,7 @@ paths: parameters: - *74 - *257 - - &703 + - &705 name: repo_name description: repo_name parameter in: path @@ -44129,7 +44129,7 @@ paths: - nuget - container - *74 - - &704 + - &706 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -44170,7 +44170,7 @@ paths: default: *263 '403': *27 '401': *23 - '400': &706 + '400': &708 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -46301,7 +46301,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &789 + - &791 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -47199,7 +47199,7 @@ paths: - updated_at - project_url examples: - default: &726 + default: &728 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47376,7 +47376,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &727 + items: &729 type: object properties: name: @@ -47413,7 +47413,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &728 + iteration_configuration: &730 type: object description: The configuration for iteration fields. properties: @@ -47463,7 +47463,7 @@ paths: value: name: Due date data_type: date - single_select_field: &729 + single_select_field: &731 summary: Create a single select field value: name: Priority @@ -47490,7 +47490,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &730 + iteration_field: &732 summary: Create an iteration field value: name: Sprint @@ -47516,7 +47516,7 @@ paths: application/json: schema: *283 examples: - text_field: &731 + text_field: &733 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -47525,7 +47525,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &732 + number_field: &734 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -47534,7 +47534,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &733 + date_field: &735 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -47543,7 +47543,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &734 + single_select_field: &736 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47577,7 +47577,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &735 + iteration_field: &737 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -47623,7 +47623,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *280 - - &736 + - &738 name: field_id description: The unique identifier of the field. in: path @@ -47638,7 +47638,7 @@ paths: application/json: schema: *283 examples: - default: &737 + default: &739 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -48849,7 +48849,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &717 + schema: &719 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -49032,7 +49032,7 @@ paths: parameters: - *280 - *74 - - &738 + - &740 name: view_number description: The number that identifies the project view. in: path @@ -51602,6 +51602,43 @@ paths: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + title: DismissalRestriction + description: Specify people, teams, or apps allowed + to dismiss pull request reviews. + type: object + properties: + allowed_actors: + type: array + description: Specify people, teams, or apps + allowed to dismiss pull request reviews. + items: + title: Actor + description: An actor allowed to dismiss pull + request reviews + type: object + properties: + id: + type: integer + description: ID of the actor that can + dismiss reviews. + type: + type: string + description: The type of the actor + enum: + - User + - Team + - IntegrationInstallation + - RepositoryRole + required: + - id + - type + enabled: + type: boolean + description: Whether to restrict review dismissal + to specific actors. + required: + - enabled require_code_owner_review: type: boolean description: Require an approving review in pull @@ -53204,6 +53241,29 @@ paths: required: false schema: type: boolean + - &646 + name: included_metadata + in: query + description: |- + A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the + specified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`, + `owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`, + `organization-id`, `last-used-date`, and `has-organization-access`. + required: false + schema: + type: string + - &647 + name: owner_email_hash + in: query + description: |- + Filters alerts to only those whose attached `owner_email` metadata field matches the + provided value. The value must be the lowercase hex-encoded SHA-256 hash of the email + address to match (for example, the SHA-256 of `user@example.com`). Only alerts that + have an `owner_email` metadata value whose SHA-256 hash equals this parameter are + returned. + required: false + schema: + type: string responses: '200': description: Response @@ -53227,14 +53287,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &646 + state: &648 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &647 + resolution: &649 type: - string - 'null' @@ -53353,14 +53413,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &648 + - &650 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &650 + - &652 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -53424,7 +53484,7 @@ paths: - blob_url - commit_sha - commit_url - - &651 + - &653 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -53485,7 +53545,7 @@ paths: - page_url - commit_sha - commit_url - - &652 + - &654 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -53507,7 +53567,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &653 + - &655 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -53529,7 +53589,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &654 + - &656 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -53551,7 +53611,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &655 + - &657 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -53566,7 +53626,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &656 + - &658 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -53581,7 +53641,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &657 + - &659 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -53596,7 +53656,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &658 + - &660 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -53618,7 +53678,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &659 + - &661 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -53640,7 +53700,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &660 + - &662 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -53662,7 +53722,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &661 + - &663 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -53684,7 +53744,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &662 + - &664 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -54205,7 +54265,7 @@ paths: application/json: schema: type: array - items: &666 + items: &668 description: A repository security advisory. type: object properties: @@ -54524,7 +54584,7 @@ paths: - private_fork additionalProperties: false examples: - default: &667 + default: &669 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -56464,7 +56524,7 @@ paths: application/json: schema: type: array - items: &682 + items: &684 title: Team Member description: A user that is a member of a team, including their role on the team and whether the membership is inherited from @@ -56607,7 +56667,7 @@ paths: - type - url examples: - default: &683 + default: &685 value: - login: octocat id: 1 @@ -56694,7 +56754,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &684 + response-if-user-is-a-team-maintainer: &686 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -56759,7 +56819,7 @@ paths: application/json: schema: *336 examples: - response-if-users-membership-with-team-is-now-pending: &685 + response-if-users-membership-with-team-is-now-pending: &687 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -56873,7 +56933,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &686 + schema: &688 title: Team Repository description: A team's access to a repository. type: object @@ -57602,7 +57662,7 @@ paths: type: array items: *200 examples: - response-if-child-teams-exist: &687 + response-if-child-teams-exist: &689 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -69712,7 +69772,7 @@ paths: check. type: array items: *85 - deployment: &750 + deployment: &752 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -75432,7 +75492,7 @@ paths: type: array items: *459 examples: - default: &693 + default: &695 value: total_count: 2 machines: @@ -78609,7 +78669,7 @@ paths: application/json: schema: type: array - items: &671 + items: &673 title: Status description: The status of a commit. type: object @@ -80235,7 +80295,7 @@ paths: items: type: object properties: - placeholder_id: &663 + placeholder_id: &665 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -86440,7 +86500,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &781 + last_response: &783 title: Hook Response type: object properties: @@ -87509,7 +87569,7 @@ paths: parameters: - *337 - *338 - - &715 + - &717 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -88094,7 +88154,7 @@ paths: type: array items: *534 examples: - default: &708 + default: &710 value: - id: 1 repository: @@ -103151,6 +103211,8 @@ paths: - *643 - *644 - *645 + - *646 + - *647 responses: '200': description: Response @@ -103158,7 +103220,7 @@ paths: application/json: schema: type: array - items: &649 + items: type: object properties: number: *180 @@ -103174,8 +103236,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *646 - resolution: *647 + state: *648 + resolution: *649 resolved_at: type: - string @@ -103281,7 +103343,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *648 + - *650 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -103449,7 +103511,168 @@ paths: description: Response content: application/json: - schema: *649 + schema: &651 + type: object + properties: + number: *180 + created_at: *181 + updated_at: + anyOf: + - type: 'null' + - *182 + url: *183 + html_url: *184 + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: *648 + resolution: *649 + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - *4 + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + provider: + type: + - string + - 'null' + description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret + that was detected. Use this value for filtering by provider + with the `providers` or `exclude_providers` parameters. + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected + secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - *4 + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO + 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection + bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the detected secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple + repositories under the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert + is base64 encoded + first_location_detected: + anyOf: + - type: 'null' + - *650 + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token + in the alert was detected in more than one location. + assigned_to: + anyOf: + - type: 'null' + - *4 + closure_request_comment: + type: + - string + - 'null' + description: An optional comment from the closure request author. + closure_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment from the closure request reviewer. + closure_request_reviewer: + anyOf: + - type: 'null' + - *4 + metadata: &802 + type: array + description: A list of metadata key/value pairs associated with + the secret scanning alert. + readOnly: true + items: + type: object + properties: + key: + type: string + description: The metadata key. + value: + type: string + description: The metadata value. + required: + - key + - value examples: default: value: @@ -103476,6 +103699,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com '304': *35 '404': description: Repository is public, or secret scanning is disabled for the @@ -103513,8 +103739,8 @@ paths: schema: type: object properties: - state: *646 - resolution: *647 + state: *648 + resolution: *649 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -103562,7 +103788,7 @@ paths: description: Response content: application/json: - schema: *649 + schema: *651 examples: default: value: @@ -103607,6 +103833,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -103674,7 +103903,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &801 + items: &804 type: object properties: type: @@ -103701,8 +103930,6 @@ paths: - commit details: oneOf: - - *650 - - *651 - *652 - *653 - *654 @@ -103714,6 +103941,8 @@ paths: - *660 - *661 - *662 + - *663 + - *664 examples: default: value: @@ -103808,14 +104037,14 @@ paths: schema: type: object properties: - reason: &664 + reason: &666 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *663 + placeholder_id: *665 required: - reason - placeholder_id @@ -103832,7 +104061,7 @@ paths: schema: type: object properties: - reason: *664 + reason: *666 expire_at: type: - string @@ -103895,7 +104124,7 @@ paths: properties: incremental_scans: type: array - items: &665 + items: &667 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103928,15 +104157,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *665 + items: *667 backfill_scans: type: array - items: *665 + items: *667 custom_pattern_backfill_scans: type: array items: allOf: - - *665 + - *667 - type: object properties: pattern_name: @@ -103949,7 +104178,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *665 + items: *667 examples: default: value: @@ -104059,9 +104288,9 @@ paths: application/json: schema: type: array - items: *666 + items: *668 examples: - default: *667 + default: *669 '400': *14 '404': *6 x-github: @@ -104255,9 +104484,9 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: &669 + default: &671 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -104604,7 +104833,7 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: default: value: @@ -104753,15 +104982,15 @@ paths: parameters: - *337 - *338 - - *668 + - *670 responses: '200': description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: *669 + default: *671 '403': *27 '404': *6 x-github: @@ -104787,7 +105016,7 @@ paths: parameters: - *337 - *338 - - *668 + - *670 requestBody: required: true content: @@ -104958,10 +105187,10 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: *669 - add_credit: *669 + default: *671 + add_credit: *671 '403': *27 '404': *6 '422': @@ -105001,7 +105230,7 @@ paths: parameters: - *337 - *338 - - *668 + - *670 responses: '202': *37 '400': *14 @@ -105030,7 +105259,7 @@ paths: parameters: - *337 - *338 - - *668 + - *670 responses: '202': description: Response @@ -105171,7 +105400,7 @@ paths: application/json: schema: type: array - items: &670 + items: &672 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -105544,7 +105773,7 @@ paths: application/json: schema: type: array - items: *670 + items: *672 examples: default: value: @@ -105634,7 +105863,7 @@ paths: description: Response content: application/json: - schema: *671 + schema: *673 examples: default: value: @@ -105728,7 +105957,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &672 + schema: &674 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -105828,7 +106057,7 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: default: value: @@ -106038,7 +106267,7 @@ paths: description: Response content: application/json: - schema: &673 + schema: &675 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -106050,7 +106279,7 @@ paths: required: - names examples: - default: &674 + default: &676 value: names: - octocat @@ -106105,9 +106334,9 @@ paths: description: Response content: application/json: - schema: *673 + schema: *675 examples: - default: *674 + default: *676 '404': *6 '422': *7 x-github: @@ -106130,7 +106359,7 @@ paths: parameters: - *337 - *338 - - &675 + - &677 name: per description: The time frame to display results for. in: query @@ -106161,7 +106390,7 @@ paths: - 128 clones: type: array - items: &676 + items: &678 title: Traffic type: object properties: @@ -106409,7 +106638,7 @@ paths: parameters: - *337 - *338 - - *675 + - *677 responses: '200': description: Response @@ -106430,7 +106659,7 @@ paths: - 3782 views: type: array - items: *676 + items: *678 required: - uniques - count @@ -107203,7 +107432,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &677 + text_matches: &679 title: Search Result Text Matches type: array items: @@ -107366,7 +107595,7 @@ paths: enum: - author-date - committer-date - - &678 + - &680 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -107486,7 +107715,7 @@ paths: type: number node_id: type: string - text_matches: *677 + text_matches: *679 required: - sha - node_id @@ -107678,7 +107907,7 @@ paths: - interactions - created - updated - - *678 + - *680 - *17 - *19 - name: advanced_search @@ -107792,8 +108021,8 @@ paths: type: - string - 'null' - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -107824,7 +108053,7 @@ paths: - string - 'null' format: date-time - text_matches: *677 + text_matches: *679 pull_request: type: object properties: @@ -108100,7 +108329,7 @@ paths: enum: - created - updated - - *678 + - *680 - *17 - *19 responses: @@ -108145,7 +108374,7 @@ paths: - 'null' score: type: number - text_matches: *677 + text_matches: *679 required: - id - node_id @@ -108230,7 +108459,7 @@ paths: - forks - help-wanted-issues - updated - - *678 + - *680 - *17 - *19 responses: @@ -108476,7 +108705,7 @@ paths: - admin - pull - push - text_matches: *677 + text_matches: *679 temp_clone_token: type: string allow_merge_commit: @@ -108784,7 +109013,7 @@ paths: - string - 'null' format: uri - text_matches: *677 + text_matches: *679 related: type: - array @@ -108977,7 +109206,7 @@ paths: - followers - repositories - joined - - *678 + - *680 - *17 - *19 responses: @@ -109087,7 +109316,7 @@ paths: type: - boolean - 'null' - text_matches: *677 + text_matches: *679 blog: type: - string @@ -109169,7 +109398,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &681 + - &683 name: team_id description: The unique identifier of the team. in: path @@ -109210,7 +109439,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *681 + - *683 requestBody: required: true content: @@ -109311,7 +109540,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *681 + - *683 responses: '204': description: Response @@ -109340,7 +109569,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -109380,7 +109609,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *681 + - *683 - name: role description: Filters members returned by their role in the team. in: query @@ -109401,9 +109630,9 @@ paths: application/json: schema: type: array - items: *682 + items: *684 examples: - default: *683 + default: *685 headers: Link: *66 '404': *6 @@ -109431,7 +109660,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -109468,7 +109697,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -109508,7 +109737,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -109545,7 +109774,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *681 + - *683 - *70 responses: '200': @@ -109554,7 +109783,7 @@ paths: application/json: schema: *336 examples: - response-if-user-is-a-team-maintainer: *684 + response-if-user-is-a-team-maintainer: *686 '404': *6 x-github: githubCloudOnly: false @@ -109587,7 +109816,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *681 + - *683 - *70 requestBody: required: false @@ -109615,7 +109844,7 @@ paths: application/json: schema: *336 examples: - response-if-users-membership-with-team-is-now-pending: *685 + response-if-users-membership-with-team-is-now-pending: *687 '403': description: Forbidden if team synchronization is set up '422': @@ -109649,7 +109878,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -109677,7 +109906,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -109719,7 +109948,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *681 + - *683 - *337 - *338 responses: @@ -109727,7 +109956,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *686 + schema: *688 examples: alternative-response-with-extra-repository-information: value: @@ -109878,7 +110107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *681 + - *683 - *337 - *338 requestBody: @@ -109930,7 +110159,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *681 + - *683 - *337 - *338 responses: @@ -109957,7 +110186,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -109969,7 +110198,7 @@ paths: type: array items: *200 examples: - response-if-child-teams-exist: *687 + response-if-child-teams-exist: *689 headers: Link: *66 '404': *6 @@ -110002,7 +110231,7 @@ paths: application/json: schema: oneOf: - - &689 + - &691 title: Private User description: Private User type: object @@ -110252,7 +110481,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *688 + - *690 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -110412,7 +110641,7 @@ paths: description: Response content: application/json: - schema: *689 + schema: *691 examples: default: value: @@ -110810,7 +111039,7 @@ paths: type: integer secrets: type: array - items: &690 + items: &692 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -110930,7 +111159,7 @@ paths: description: Response content: application/json: - schema: *690 + schema: *692 examples: default: value: @@ -111343,7 +111572,7 @@ paths: description: Response content: application/json: - schema: &691 + schema: &693 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -111396,7 +111625,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &692 + default: &694 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -111441,9 +111670,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: *692 + default: *694 '404': *6 x-github: githubCloudOnly: false @@ -111482,7 +111711,7 @@ paths: type: array items: *459 examples: - default: *693 + default: *695 '304': *35 '500': *53 '401': *23 @@ -112448,7 +112677,7 @@ paths: type: array items: *262 examples: - default: &705 + default: &707 value: - id: 197 name: hello_docker @@ -112549,7 +112778,7 @@ paths: application/json: schema: type: array - items: &694 + items: &696 title: Email description: Email type: object @@ -112619,9 +112848,9 @@ paths: application/json: schema: type: array - items: *694 + items: *696 examples: - default: &707 + default: &709 value: - email: octocat@github.com verified: true @@ -112698,7 +112927,7 @@ paths: application/json: schema: type: array - items: *694 + items: *696 examples: default: value: @@ -112956,7 +113185,7 @@ paths: application/json: schema: type: array - items: &695 + items: &697 title: GPG Key description: A unique encryption key type: object @@ -113101,7 +113330,7 @@ paths: - subkeys - revoked examples: - default: &724 + default: &726 value: - id: 3 name: Octocat's GPG Key @@ -113186,9 +113415,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: &696 + default: &698 value: id: 3 name: Octocat's GPG Key @@ -113245,7 +113474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &697 + - &699 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -113257,9 +113486,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: *696 + default: *698 '404': *6 '304': *35 '403': *27 @@ -113282,7 +113511,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *697 + - *699 responses: '204': description: Response @@ -113749,7 +113978,7 @@ paths: application/json: schema: type: array - items: &698 + items: &700 title: Key description: Key type: object @@ -113852,9 +114081,9 @@ paths: description: Response content: application/json: - schema: *698 + schema: *700 examples: - default: &699 + default: &701 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -113893,9 +114122,9 @@ paths: description: Response content: application/json: - schema: *698 + schema: *700 examples: - default: *699 + default: *701 '404': *6 '304': *35 '403': *27 @@ -113951,7 +114180,7 @@ paths: application/json: schema: type: array - items: &700 + items: &702 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -114030,7 +114259,7 @@ paths: - account - plan examples: - default: &701 + default: &703 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -114092,9 +114321,9 @@ paths: application/json: schema: type: array - items: *700 + items: *702 examples: - default: *701 + default: *703 headers: Link: *66 '304': *35 @@ -114337,7 +114566,7 @@ paths: application/json: schema: *254 examples: - default: &702 + default: &704 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -114386,7 +114615,7 @@ paths: application/json: schema: *254 examples: - default: *702 + default: *704 '403': *27 '404': *6 '422': *15 @@ -115120,7 +115349,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *257 - - *703 + - *705 responses: '204': description: Response @@ -115235,7 +115464,7 @@ paths: - docker - nuget - container - - *704 + - *706 - *19 - *17 responses: @@ -115247,8 +115476,8 @@ paths: type: array items: *262 examples: - default: *705 - '400': *706 + default: *707 + '400': *708 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -115277,7 +115506,7 @@ paths: application/json: schema: *262 examples: - default: &725 + default: &727 value: id: 40201 name: octo-name @@ -115639,9 +115868,9 @@ paths: application/json: schema: type: array - items: *694 + items: *696 examples: - default: *707 + default: *709 headers: Link: *66 '304': *35 @@ -115754,7 +115983,7 @@ paths: type: array items: *78 examples: - default: &714 + default: &716 summary: Default response value: - id: 1296269 @@ -116114,7 +116343,7 @@ paths: type: array items: *534 examples: - default: *708 + default: *710 headers: Link: *66 '304': *35 @@ -116193,7 +116422,7 @@ paths: application/json: schema: type: array - items: &709 + items: &711 title: Social account description: Social media account type: object @@ -116210,7 +116439,7 @@ paths: - provider - url examples: - default: &710 + default: &712 value: - provider: twitter url: https://twitter.com/github @@ -116273,9 +116502,9 @@ paths: application/json: schema: type: array - items: *709 + items: *711 examples: - default: *710 + default: *712 '422': *15 '304': *35 '404': *6 @@ -116363,7 +116592,7 @@ paths: application/json: schema: type: array - items: &711 + items: &713 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -116383,7 +116612,7 @@ paths: - title - created_at examples: - default: &742 + default: &744 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -116448,9 +116677,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: &712 + default: &714 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -116480,7 +116709,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &713 + - &715 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -116492,9 +116721,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: *712 + default: *714 '404': *6 '304': *35 '403': *27 @@ -116517,7 +116746,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *713 + - *715 responses: '204': description: Response @@ -116546,7 +116775,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &743 + - &745 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -116571,11 +116800,11 @@ paths: type: array items: *78 examples: - default-response: *714 + default-response: *716 application/vnd.github.v3.star+json: schema: type: array - items: &744 + items: &746 title: Starred Repository description: Starred Repository type: object @@ -116944,10 +117173,10 @@ paths: application/json: schema: oneOf: - - *689 - - *688 + - *691 + - *690 examples: - default-response: &718 + default-response: &720 summary: Default response value: login: octocat @@ -116982,7 +117211,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &719 + response-with-git-hub-plan-information: &721 summary: Response with GitHub plan information value: login: octocat @@ -117039,7 +117268,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &716 + - &718 name: user_id description: The unique identifier of the user. in: path @@ -117105,7 +117334,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *715 + - *717 - *17 responses: '200': @@ -117140,7 +117369,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *716 + - *718 - *280 requestBody: required: true @@ -117215,7 +117444,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *717 + schema: *719 examples: table_view: summary: Response for creating a table view @@ -117267,11 +117496,11 @@ paths: application/json: schema: oneOf: - - *689 - - *688 + - *691 + - *690 examples: - default-response: *718 - response-with-git-hub-plan-information: *719 + default-response: *720 + response-with-git-hub-plan-information: *721 '404': *6 x-github: githubCloudOnly: false @@ -117321,8 +117550,8 @@ paths: required: - subject_digests examples: - default: *720 - withPredicateType: *721 + default: *722 + withPredicateType: *723 responses: '200': description: Response @@ -117376,7 +117605,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *722 + default: *724 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -117865,7 +118094,7 @@ paths: application/json: schema: *196 examples: - default: &723 + default: &725 summary: Example response for a user copilot space value: id: 42 @@ -117966,7 +118195,7 @@ paths: application/json: schema: *196 examples: - default: *723 + default: *725 '403': *27 '404': *6 x-github: @@ -118092,7 +118321,7 @@ paths: application/json: schema: *196 examples: - default: *723 + default: *725 '403': *27 '404': *6 '422': *15 @@ -118860,7 +119089,7 @@ paths: type: array items: *262 examples: - default: *705 + default: *707 '403': *27 '401': *23 x-github: @@ -119244,9 +119473,9 @@ paths: application/json: schema: type: array - items: *695 + items: *697 examples: - default: *724 + default: *726 headers: Link: *66 x-github: @@ -119475,7 +119704,7 @@ paths: - docker - nuget - container - - *704 + - *706 - *70 - *19 - *17 @@ -119488,10 +119717,10 @@ paths: type: array items: *262 examples: - default: *705 + default: *707 '403': *27 '401': *23 - '400': *706 + '400': *708 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119521,7 +119750,7 @@ paths: application/json: schema: *262 examples: - default: *725 + default: *727 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119870,7 +120099,7 @@ paths: type: array items: *283 examples: - default: *726 + default: *728 headers: Link: *66 '304': *35 @@ -119930,7 +120159,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *727 + items: *729 required: - name - data_type @@ -119946,7 +120175,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *728 + iteration_configuration: *730 required: - name - data_type @@ -119968,8 +120197,8 @@ paths: value: name: Due date data_type: date - single_select_field: *729 - iteration_field: *730 + single_select_field: *731 + iteration_field: *732 responses: '201': description: Response @@ -119977,11 +120206,11 @@ paths: application/json: schema: *283 examples: - text_field: *731 - number_field: *732 - date_field: *733 - single_select_field: *734 - iteration_field: *735 + text_field: *733 + number_field: *734 + date_field: *735 + single_select_field: *736 + iteration_field: *737 '304': *35 '403': *27 '401': *23 @@ -120003,7 +120232,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *280 - - *736 + - *738 - *70 responses: '200': @@ -120012,7 +120241,7 @@ paths: application/json: schema: *283 examples: - default: *737 + default: *739 headers: Link: *66 '304': *35 @@ -120369,7 +120598,7 @@ paths: parameters: - *280 - *70 - - *738 + - *740 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -120908,7 +121137,7 @@ paths: parameters: - *70 - *116 - - *739 + - *741 - *118 responses: '200': @@ -121007,9 +121236,9 @@ paths: - *116 - *117 - *118 - - *740 + - *742 - *121 - - *741 + - *743 responses: '200': description: Response when getting a billing usage summary @@ -121143,9 +121372,9 @@ paths: application/json: schema: type: array - items: *709 + items: *711 examples: - default: *710 + default: *712 headers: Link: *66 x-github: @@ -121175,9 +121404,9 @@ paths: application/json: schema: type: array - items: *711 + items: *713 examples: - default: *742 + default: *744 headers: Link: *66 x-github: @@ -121202,7 +121431,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *70 - - *743 + - *745 - *60 - *17 - *19 @@ -121214,11 +121443,11 @@ paths: schema: anyOf: - type: array - items: *744 + items: *746 - type: array items: *78 examples: - default-response: *714 + default-response: *716 headers: Link: *66 x-github: @@ -121378,7 +121607,7 @@ webhooks: type: string enum: - disabled - enterprise: &745 + enterprise: &747 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -121447,7 +121676,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &746 + installation: &748 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -121468,7 +121697,7 @@ webhooks: required: - id - node_id - organization: &747 + organization: &749 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -121541,7 +121770,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &748 + repository: &750 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -122467,10 +122696,10 @@ webhooks: type: string enum: - enabled - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -122546,11 +122775,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - rule: &749 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + rule: &751 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -122773,11 +123002,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - rule: *749 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + rule: *751 sender: *4 required: - action @@ -122965,11 +123194,11 @@ webhooks: - everyone required: - from - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - rule: *749 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + rule: *751 sender: *4 required: - action @@ -123053,7 +123282,7 @@ webhooks: type: string enum: - completed - check_run: &751 + check_run: &753 title: CheckRun description: A check performed on the code of a given code change type: object @@ -123163,7 +123392,7 @@ webhooks: - examples: - neutral - deployment: *750 + deployment: *752 details_url: type: string examples: @@ -123261,10 +123490,10 @@ webhooks: - output - app - pull_requests - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 sender: *4 required: - check_run @@ -123655,11 +123884,11 @@ webhooks: type: string enum: - created - check_run: *751 - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + check_run: *753 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 sender: *4 required: - check_run @@ -124053,11 +124282,11 @@ webhooks: type: string enum: - requested_action - check_run: *751 - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + check_run: *753 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 requested_action: description: The action requested by the user. type: object @@ -124460,11 +124689,11 @@ webhooks: type: string enum: - rerequested - check_run: *751 - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + check_run: *753 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 sender: *4 required: - check_run @@ -125449,10 +125678,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -126166,10 +126395,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -126877,10 +127106,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -127201,20 +127430,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &752 + commit_oid: &754 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *745 - installation: *746 - organization: *747 - ref: &753 + enterprise: *747 + installation: *748 + organization: *749 + ref: &755 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *748 + repository: *750 sender: *4 required: - action @@ -127622,12 +127851,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -127910,12 +128139,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -128261,12 +128490,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -128556,9 +128785,9 @@ webhooks: type: - string - 'null' - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -128566,7 +128795,7 @@ webhooks: type: - string - 'null' - repository: *748 + repository: *750 sender: *4 required: - action @@ -128812,12 +129041,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -129138,10 +129367,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -129401,10 +129630,10 @@ webhooks: - updated_at - author_association - body - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -129485,18 +129714,18 @@ webhooks: type: - string - 'null' - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *747 - pusher_type: &754 + organization: *749 + pusher_type: &756 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &755 + ref: &757 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -129506,7 +129735,7 @@ webhooks: enum: - tag - branch - repository: *748 + repository: *750 sender: *4 required: - ref @@ -129589,9 +129818,9 @@ webhooks: enum: - created definition: *291 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -129676,9 +129905,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -129756,9 +129985,9 @@ webhooks: enum: - promote_to_enterprise definition: *291 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -129836,9 +130065,9 @@ webhooks: enum: - updated definition: *291 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -129915,10 +130144,10 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - repository: *748 - organization: *747 + enterprise: *747 + installation: *748 + repository: *750 + organization: *749 sender: *4 new_property_values: type: array @@ -130003,18 +130232,18 @@ webhooks: title: delete event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - pusher_type: *754 - ref: *755 + enterprise: *747 + installation: *748 + organization: *749 + pusher_type: *756 + ref: *757 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *748 + repository: *750 sender: *4 required: - ref @@ -130095,10 +130324,10 @@ webhooks: enum: - assignees_changed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130179,10 +130408,10 @@ webhooks: enum: - auto_dismissed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130264,10 +130493,10 @@ webhooks: enum: - auto_reopened alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130349,10 +130578,10 @@ webhooks: enum: - created alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130432,10 +130661,10 @@ webhooks: enum: - dismissed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130515,10 +130744,10 @@ webhooks: enum: - fixed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130599,10 +130828,10 @@ webhooks: enum: - reintroduced alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130682,10 +130911,10 @@ webhooks: enum: - reopened alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130762,9 +130991,9 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - key: &756 + enterprise: *747 + installation: *748 + key: &758 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -130802,8 +131031,8 @@ webhooks: - verified - created_at - read_only - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -130880,11 +131109,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - key: *756 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + key: *758 + organization: *749 + repository: *750 sender: *4 required: - action @@ -131451,12 +131680,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: &760 + workflow: &762 title: Workflow type: - object @@ -132211,9 +132440,9 @@ webhooks: pull_requests: type: array items: *596 - repository: *748 - organization: *747 - installation: *746 + repository: *750 + organization: *749 + installation: *748 sender: *4 responses: '200': @@ -132284,7 +132513,7 @@ webhooks: type: string enum: - approved - approver: &757 + approver: &759 type: object properties: avatar_url: @@ -132327,11 +132556,11 @@ webhooks: type: string comment: type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - reviewers: &758 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + reviewers: &760 type: array items: type: object @@ -132412,7 +132641,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &759 + workflow_job_run: &761 type: object properties: conclusion: @@ -133158,18 +133387,18 @@ webhooks: type: string enum: - rejected - approver: *757 + approver: *759 comment: type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - reviewers: *758 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + reviewers: *760 sender: *4 since: type: string - workflow_job_run: *759 + workflow_job_run: *761 workflow_job_runs: type: array items: @@ -133886,13 +134115,13 @@ webhooks: type: string enum: - requested - enterprise: *745 + enterprise: *747 environment: type: string - installation: *746 - organization: *747 - repository: *748 - requestor: &765 + installation: *748 + organization: *749 + repository: *750 + requestor: &767 title: User type: - object @@ -135825,12 +136054,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Deployment Workflow Run type: @@ -136521,7 +136750,7 @@ webhooks: type: string enum: - answered - answer: &763 + answer: &765 type: object properties: author_association: @@ -136681,11 +136910,11 @@ webhooks: - created_at - updated_at - body - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -136812,11 +137041,11 @@ webhooks: - from required: - category - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -136899,11 +137128,11 @@ webhooks: type: string enum: - closed - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -136985,7 +137214,7 @@ webhooks: type: string enum: - created - comment: &762 + comment: &764 type: object properties: author_association: @@ -137145,11 +137374,11 @@ webhooks: - updated_at - body - reactions - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137232,12 +137461,12 @@ webhooks: type: string enum: - deleted - comment: *762 - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + comment: *764 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137332,12 +137561,12 @@ webhooks: - from required: - body - comment: *762 - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + comment: *764 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137421,11 +137650,11 @@ webhooks: type: string enum: - created - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137507,11 +137736,11 @@ webhooks: type: string enum: - deleted - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137611,11 +137840,11 @@ webhooks: type: string required: - from - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137697,10 +137926,10 @@ webhooks: type: string enum: - labeled - discussion: *761 - enterprise: *745 - installation: *746 - label: &764 + discussion: *763 + enterprise: *747 + installation: *748 + label: &766 title: Label type: object properties: @@ -137733,8 +137962,8 @@ webhooks: - color - default - description - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137817,11 +138046,11 @@ webhooks: type: string enum: - locked - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137903,11 +138132,11 @@ webhooks: type: string enum: - pinned - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137989,11 +138218,11 @@ webhooks: type: string enum: - reopened - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138078,16 +138307,16 @@ webhooks: changes: type: object properties: - new_discussion: *761 - new_repository: *748 + new_discussion: *763 + new_repository: *750 required: - new_discussion - new_repository - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138170,10 +138399,10 @@ webhooks: type: string enum: - unanswered - discussion: *761 - old_answer: *763 - organization: *747 - repository: *748 + discussion: *763 + old_answer: *765 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138255,12 +138484,12 @@ webhooks: type: string enum: - unlabeled - discussion: *761 - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138343,11 +138572,11 @@ webhooks: type: string enum: - unlocked - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138429,11 +138658,11 @@ webhooks: type: string enum: - unpinned - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138506,7 +138735,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *745 + enterprise: *747 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -139184,9 +139413,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - forkee @@ -139332,9 +139561,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pages: description: The pages that were updated. type: array @@ -139372,7 +139601,7 @@ webhooks: - action - sha - html_url - repository: *748 + repository: *750 sender: *4 required: - pages @@ -139448,10 +139677,10 @@ webhooks: type: string enum: - created - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: &766 + organization: *749 + repositories: &768 description: An array of repository objects that the installation can access. type: array @@ -139477,8 +139706,8 @@ webhooks: - name - full_name - private - repository: *748 - requester: *765 + repository: *750 + requester: *767 sender: *4 required: - action @@ -139553,11 +139782,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -139634,11 +139863,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -139715,10 +139944,10 @@ webhooks: type: string enum: - added - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories_added: &767 + organization: *749 + repositories_added: &769 description: An array of repository objects, which were added to the installation. type: array @@ -139764,15 +139993,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *748 - repository_selection: &768 + repository: *750 + repository_selection: &770 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *765 + requester: *767 sender: *4 required: - action @@ -139851,10 +140080,10 @@ webhooks: type: string enum: - removed - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories_added: *767 + organization: *749 + repositories_added: *769 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -139881,9 +140110,9 @@ webhooks: - name - full_name - private - repository: *748 - repository_selection: *768 - requester: *765 + repository: *750 + repository_selection: *770 + requester: *767 sender: *4 required: - action @@ -139962,11 +140191,11 @@ webhooks: type: string enum: - suspend - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -140148,10 +140377,10 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 target_type: type: string @@ -140230,11 +140459,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -140490,8 +140719,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -141303,8 +141532,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141665,8 +141894,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -141746,7 +141975,7 @@ webhooks: type: string enum: - deleted - comment: &769 + comment: &771 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -141921,8 +142150,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -142730,8 +142959,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143094,8 +143323,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -143175,7 +143404,7 @@ webhooks: type: string enum: - edited - changes: &793 + changes: &795 description: The changes to the comment. type: object properties: @@ -143187,9 +143416,9 @@ webhooks: type: string required: - from - comment: *769 - enterprise: *745 - installation: *746 + comment: *771 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -144000,8 +144229,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144362,8 +144591,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -144444,9 +144673,9 @@ webhooks: type: string enum: - pinned - comment: *769 - enterprise: *745 - installation: *746 + comment: *771 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -145259,8 +145488,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145623,8 +145852,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -145704,9 +145933,9 @@ webhooks: type: string enum: - unpinned - comment: *769 - enterprise: *745 - installation: *746 + comment: *771 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -146519,8 +146748,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146883,8 +147112,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -146973,9 +147202,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -147064,9 +147293,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -147154,9 +147383,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -147245,9 +147474,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -147327,10 +147556,10 @@ webhooks: type: string enum: - assigned - assignee: *765 - enterprise: *745 - installation: *746 - issue: &770 + assignee: *767 + enterprise: *747 + installation: *748 + issue: &772 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -148141,8 +148370,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -148265,8 +148494,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -148346,8 +148575,8 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -149163,8 +149392,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -149430,8 +149659,8 @@ webhooks: required: - state - closed_at - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -149510,8 +149739,8 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150318,8 +150547,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -150441,8 +150670,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -150521,8 +150750,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151352,8 +151581,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -151454,7 +151683,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &771 + milestone: &773 title: Milestone description: A collection of related issues and pull requests. type: object @@ -151597,8 +151826,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -151697,8 +151926,8 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152509,8 +152738,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -152633,9 +152862,9 @@ webhooks: - active_lock_reason - body - reactions - label: *764 - organization: *747 - repository: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -152715,9 +152944,9 @@ webhooks: type: string enum: - field_added - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 issue_field: type: object description: The issue field whose value was set or updated on the @@ -152883,8 +153112,8 @@ webhooks: - id required: - from - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -152964,9 +153193,9 @@ webhooks: type: string enum: - field_removed - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -153053,8 +153282,8 @@ webhooks: - 'null' required: - id - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -153134,8 +153363,8 @@ webhooks: type: string enum: - labeled - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153945,8 +154174,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -154069,9 +154298,9 @@ webhooks: - active_lock_reason - body - reactions - label: *764 - organization: *747 - repository: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -154151,8 +154380,8 @@ webhooks: type: string enum: - locked - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -154987,8 +155216,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -155088,8 +155317,8 @@ webhooks: format: uri user_view_type: type: string - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -155168,8 +155397,8 @@ webhooks: type: string enum: - milestoned - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -155998,8 +156227,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -156099,9 +156328,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *771 - organization: *747 - repository: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -156988,8 +157217,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -157584,8 +157813,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -158392,8 +158621,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -158519,8 +158748,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -158600,9 +158829,9 @@ webhooks: type: string enum: - pinned - enterprise: *745 - installation: *746 - issue: &772 + enterprise: *747 + installation: *748 + issue: &774 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -159407,8 +159636,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -159530,8 +159759,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -159610,8 +159839,8 @@ webhooks: type: string enum: - reopened - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -160444,8 +160673,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -160546,8 +160775,8 @@ webhooks: user_view_type: type: string type: *245 - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -161435,8 +161664,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -162049,11 +162278,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *745 - installation: *746 - issue: *772 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *774 + organization: *749 + repository: *750 sender: *4 required: - action @@ -162133,12 +162362,12 @@ webhooks: type: string enum: - typed - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 type: *245 - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -162219,7 +162448,7 @@ webhooks: type: string enum: - unassigned - assignee: &796 + assignee: &798 title: User type: - object @@ -162291,11 +162520,11 @@ webhooks: required: - login - id - enterprise: *745 - installation: *746 - issue: *770 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *772 + organization: *749 + repository: *750 sender: *4 required: - action @@ -162374,12 +162603,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *745 - installation: *746 - issue: *770 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *772 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -162459,8 +162688,8 @@ webhooks: type: string enum: - unlocked - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -163293,8 +163522,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -163394,8 +163623,8 @@ webhooks: format: uri user_view_type: type: string - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163475,11 +163704,11 @@ webhooks: type: string enum: - unpinned - enterprise: *745 - installation: *746 - issue: *772 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *774 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163558,12 +163787,12 @@ webhooks: type: string enum: - untyped - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 type: *245 - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163643,11 +163872,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163725,11 +163954,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163839,11 +164068,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163925,9 +164154,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: &773 + enterprise: *747 + installation: *748 + marketplace_purchase: &775 title: Marketplace Purchase type: object required: @@ -164015,8 +164244,8 @@ webhooks: type: integer unit_count: type: integer - organization: *747 - previous_marketplace_purchase: &774 + organization: *749 + previous_marketplace_purchase: &776 title: Marketplace Purchase type: object properties: @@ -164100,7 +164329,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *748 + repository: *750 sender: *4 required: - action @@ -164180,10 +164409,10 @@ webhooks: - changed effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: *773 - organization: *747 + enterprise: *747 + installation: *748 + marketplace_purchase: *775 + organization: *749 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -164271,7 +164500,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *748 + repository: *750 sender: *4 required: - action @@ -164353,10 +164582,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: *773 - organization: *747 + enterprise: *747 + installation: *748 + marketplace_purchase: *775 + organization: *749 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -164442,7 +164671,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *748 + repository: *750 sender: *4 required: - action @@ -164523,8 +164752,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 marketplace_purchase: title: Marketplace Purchase type: object @@ -164610,9 +164839,9 @@ webhooks: type: integer unit_count: type: integer - organization: *747 - previous_marketplace_purchase: *774 - repository: *748 + organization: *749 + previous_marketplace_purchase: *776 + repository: *750 sender: *4 required: - action @@ -164692,12 +164921,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: *773 - organization: *747 - previous_marketplace_purchase: *774 - repository: *748 + enterprise: *747 + installation: *748 + marketplace_purchase: *775 + organization: *749 + previous_marketplace_purchase: *776 + repository: *750 sender: *4 required: - action @@ -164799,11 +165028,11 @@ webhooks: type: string required: - to - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 sender: *4 required: - action @@ -164905,11 +165134,11 @@ webhooks: type: - string - 'null' - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 sender: *4 required: - action @@ -164988,11 +165217,11 @@ webhooks: type: string enum: - removed - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 sender: *4 required: - action @@ -165070,11 +165299,11 @@ webhooks: type: string enum: - added - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 scope: description: The scope of the membership. Currently, can only be `team`. @@ -165152,7 +165381,7 @@ webhooks: required: - login - id - team: &775 + team: &777 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -165382,11 +165611,11 @@ webhooks: type: string enum: - removed - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 scope: description: The scope of the membership. Currently, can only be `team`. @@ -165465,7 +165694,7 @@ webhooks: required: - login - id - team: *775 + team: *777 required: - action - scope @@ -165547,8 +165776,8 @@ webhooks: type: string enum: - checks_requested - installation: *746 - merge_group: &776 + installation: *748 + merge_group: &778 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -165574,8 +165803,8 @@ webhooks: - base_sha - base_ref - head_commit - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -165661,10 +165890,10 @@ webhooks: - merged - invalidated - dequeued - installation: *746 - merge_group: *776 - organization: *747 - repository: *748 + installation: *748 + merge_group: *778 + organization: *749 + repository: *750 sender: *4 required: - action @@ -165737,7 +165966,7 @@ webhooks: type: string enum: - deleted - enterprise: *745 + enterprise: *747 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -165846,12 +166075,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *746 - organization: *747 + installation: *748 + organization: *749 repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -165931,11 +166160,11 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 - milestone: *771 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166014,9 +166243,9 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - milestone: &777 + enterprise: *747 + installation: *748 + milestone: &779 title: Milestone description: A collection of related issues and pull requests. type: object @@ -166158,8 +166387,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166238,11 +166467,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - milestone: *771 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166352,11 +166581,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - milestone: *771 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166436,11 +166665,11 @@ webhooks: type: string enum: - opened - enterprise: *745 - installation: *746 - milestone: *777 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *779 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166519,11 +166748,11 @@ webhooks: type: string enum: - blocked - blocked_user: *765 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + blocked_user: *767 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166602,11 +166831,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *765 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + blocked_user: *767 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166685,9 +166914,9 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - membership: &778 + enterprise: *747 + installation: *748 + membership: &780 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -166797,8 +167026,8 @@ webhooks: - role - organization_url - user - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166876,11 +167105,11 @@ webhooks: type: string enum: - member_added - enterprise: *745 - installation: *746 - membership: *778 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + membership: *780 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166959,8 +167188,8 @@ webhooks: type: string enum: - member_invited - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -167082,10 +167311,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 - user: *765 + user: *767 required: - action - invitation @@ -167163,11 +167392,11 @@ webhooks: type: string enum: - member_removed - enterprise: *745 - installation: *746 - membership: *778 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + membership: *780 + organization: *749 + repository: *750 sender: *4 required: - action @@ -167254,11 +167483,11 @@ webhooks: properties: from: type: string - enterprise: *745 - installation: *746 - membership: *778 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + membership: *780 + organization: *749 + repository: *750 sender: *4 required: - action @@ -167335,9 +167564,9 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 package: description: Information about the package. type: object @@ -167860,7 +168089,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &779 + items: &781 title: Ruby Gems metadata type: object properties: @@ -167957,7 +168186,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -168033,9 +168262,9 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 package: description: Information about the package. type: object @@ -168397,7 +168626,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *779 + items: *781 source_url: type: string format: uri @@ -168468,7 +168697,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -168648,12 +168877,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *745 + enterprise: *747 id: type: integer - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - id @@ -168730,7 +168959,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &780 + personal_access_token_request: &782 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -168880,10 +169109,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *745 - organization: *747 + enterprise: *747 + organization: *749 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -168960,11 +169189,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *780 - enterprise: *745 - organization: *747 + personal_access_token_request: *782 + enterprise: *747 + organization: *749 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -169040,11 +169269,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *780 - enterprise: *745 - organization: *747 + personal_access_token_request: *782 + enterprise: *747 + organization: *749 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -169119,11 +169348,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *780 - organization: *747 - enterprise: *745 + personal_access_token_request: *782 + organization: *749 + enterprise: *747 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -169228,7 +169457,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *781 + last_response: *783 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -169260,8 +169489,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 zen: description: Random string of GitHub zen. @@ -169506,10 +169735,10 @@ webhooks: - from required: - note - enterprise: *745 - installation: *746 - organization: *747 - project_card: &782 + enterprise: *747 + installation: *748 + organization: *749 + project_card: &784 title: Project Card type: object properties: @@ -169632,7 +169861,7 @@ webhooks: - creator - created_at - updated_at - repository: *748 + repository: *750 sender: *4 required: - action @@ -169713,11 +169942,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - project_card: *782 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_card: *784 + repository: *750 sender: *4 required: - action @@ -169797,9 +170026,9 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 project_card: title: Project Card type: object @@ -169929,7 +170158,7 @@ webhooks: repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -170023,11 +170252,11 @@ webhooks: - from required: - note - enterprise: *745 - installation: *746 - organization: *747 - project_card: *782 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_card: *784 + repository: *750 sender: *4 required: - action @@ -170121,9 +170350,9 @@ webhooks: - from required: - column_id - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 project_card: allOf: - title: Project Card @@ -170320,7 +170549,7 @@ webhooks: type: string required: - after_id - repository: *748 + repository: *750 sender: *4 required: - action @@ -170400,10 +170629,10 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 - organization: *747 - project: &784 + enterprise: *747 + installation: *748 + organization: *749 + project: &786 title: Project type: object properties: @@ -170530,7 +170759,7 @@ webhooks: - creator - created_at - updated_at - repository: *748 + repository: *750 sender: *4 required: - action @@ -170610,10 +170839,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - project_column: &783 + enterprise: *747 + installation: *748 + organization: *749 + project_column: &785 title: Project Column type: object properties: @@ -170653,7 +170882,7 @@ webhooks: - name - created_at - updated_at - repository: *748 + repository: *750 sender: *4 required: - action @@ -170732,14 +170961,14 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - project_column: *783 + enterprise: *747 + installation: *748 + organization: *749 + project_column: *785 repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -170828,11 +171057,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - project_column: *783 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_column: *785 + repository: *750 sender: *4 required: - action @@ -170912,11 +171141,11 @@ webhooks: type: string enum: - moved - enterprise: *745 - installation: *746 - organization: *747 - project_column: *783 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_column: *785 + repository: *750 sender: *4 required: - action @@ -170996,11 +171225,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - project: *784 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 + repository: *750 sender: *4 required: - action @@ -171080,14 +171309,14 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - project: *784 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -171188,11 +171417,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - project: *784 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 + repository: *750 sender: *4 required: - action @@ -171271,11 +171500,11 @@ webhooks: type: string enum: - reopened - enterprise: *745 - installation: *746 - organization: *747 - project: *784 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 + repository: *750 sender: *4 required: - action @@ -171356,8 +171585,8 @@ webhooks: type: string enum: - closed - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -171439,8 +171668,8 @@ webhooks: type: string enum: - created - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -171522,8 +171751,8 @@ webhooks: type: string enum: - deleted - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -171645,8 +171874,8 @@ webhooks: type: string to: type: string - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -171730,7 +171959,7 @@ webhooks: type: string enum: - archived - changes: &788 + changes: &790 type: object properties: archived_at: @@ -171746,9 +171975,9 @@ webhooks: - string - 'null' format: date-time - installation: *746 - organization: *747 - projects_v2_item: &785 + installation: *748 + organization: *749 + projects_v2_item: &787 title: Projects v2 Item description: An item belonging to a project type: object @@ -171888,9 +172117,9 @@ webhooks: - 'null' to: type: string - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -171972,9 +172201,9 @@ webhooks: type: string enum: - created - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -172055,9 +172284,9 @@ webhooks: type: string enum: - deleted - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -172162,7 +172391,7 @@ webhooks: oneOf: - type: string - type: integer - - &786 + - &788 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -172186,7 +172415,7 @@ webhooks: required: - id - name - - &787 + - &789 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -172226,8 +172455,8 @@ webhooks: oneOf: - type: string - type: integer - - *786 - - *787 + - *788 + - *789 type: - 'null' - string @@ -172250,9 +172479,9 @@ webhooks: - 'null' required: - body - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -172349,9 +172578,9 @@ webhooks: type: - string - 'null' - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -172434,10 +172663,10 @@ webhooks: type: string enum: - restored - changes: *788 - installation: *746 - organization: *747 - projects_v2_item: *785 + changes: *790 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -172519,8 +172748,8 @@ webhooks: type: string enum: - reopened - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -172602,9 +172831,9 @@ webhooks: type: string enum: - created - installation: *746 - organization: *747 - projects_v2_status_update: *789 + installation: *748 + organization: *749 + projects_v2_status_update: *791 sender: *4 required: - action @@ -172685,9 +172914,9 @@ webhooks: type: string enum: - deleted - installation: *746 - organization: *747 - projects_v2_status_update: *789 + installation: *748 + organization: *749 + projects_v2_status_update: *791 sender: *4 required: - action @@ -172833,9 +173062,9 @@ webhooks: - string - 'null' format: date - installation: *746 - organization: *747 - projects_v2_status_update: *789 + installation: *748 + organization: *749 + projects_v2_status_update: *791 sender: *4 required: - action @@ -172906,10 +173135,10 @@ webhooks: title: public event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - repository @@ -172986,13 +173215,13 @@ webhooks: type: string enum: - assigned - assignee: *765 - enterprise: *745 - installation: *746 - number: &790 + assignee: *767 + enterprise: *747 + installation: *748 + number: &792 description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -175363,7 +175592,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -175445,11 +175674,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -177813,7 +178042,7 @@ webhooks: - draft reason: type: string - repository: *748 + repository: *750 sender: *4 required: - action @@ -177895,11 +178124,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -180263,7 +180492,7 @@ webhooks: - draft reason: type: string - repository: *748 + repository: *750 sender: *4 required: - action @@ -180345,11 +180574,11 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: &791 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: &793 allOf: - *596 - type: object @@ -180413,7 +180642,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *748 + repository: *750 sender: *4 required: - action @@ -180494,12 +180723,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -180579,11 +180808,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *745 + enterprise: *747 milestone: *281 - number: *790 - organization: *747 - pull_request: &792 + number: *792 + organization: *749 + pull_request: &794 title: Pull Request type: object properties: @@ -182932,7 +183161,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -183011,11 +183240,11 @@ webhooks: type: string enum: - dequeued - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -185383,7 +185612,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *748 + repository: *750 sender: *4 required: - action @@ -185507,12 +185736,12 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -185592,11 +185821,11 @@ webhooks: type: string enum: - enqueued - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -187949,7 +188178,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -188029,11 +188258,11 @@ webhooks: type: string enum: - labeled - enterprise: *745 - installation: *746 - label: *764 - number: *790 - organization: *747 + enterprise: *747 + installation: *748 + label: *766 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -190403,7 +190632,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -190484,10 +190713,10 @@ webhooks: type: string enum: - locked - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -192855,7 +193084,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -192935,12 +193164,12 @@ webhooks: type: string enum: - milestoned - enterprise: *745 + enterprise: *747 milestone: *281 - number: *790 - organization: *747 - pull_request: *792 - repository: *748 + number: *792 + organization: *749 + pull_request: *794 + repository: *750 sender: *4 required: - action @@ -193019,12 +193248,12 @@ webhooks: type: string enum: - opened - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -193105,12 +193334,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -193190,12 +193419,12 @@ webhooks: type: string enum: - reopened - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -193570,9 +193799,9 @@ webhooks: - start_side - side - reactions - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: type: object properties: @@ -195824,7 +196053,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *748 + repository: *750 sender: *4 required: - action @@ -195904,7 +196133,7 @@ webhooks: type: string enum: - deleted - comment: &794 + comment: &796 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -196197,9 +196426,9 @@ webhooks: - start_side - side - reactions - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: type: object properties: @@ -198439,7 +198668,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *748 + repository: *750 sender: *4 required: - action @@ -198519,11 +198748,11 @@ webhooks: type: string enum: - edited - changes: *793 - comment: *794 - enterprise: *745 - installation: *746 - organization: *747 + changes: *795 + comment: *796 + enterprise: *747 + installation: *748 + organization: *749 pull_request: type: object properties: @@ -200766,7 +200995,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *748 + repository: *750 sender: *4 required: - action @@ -200847,9 +201076,9 @@ webhooks: type: string enum: - dismissed - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -203104,7 +203333,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 + repository: *750 review: description: The review that was affected. type: object @@ -203355,9 +203584,9 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -205471,8 +205700,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 - review: &795 + repository: *750 + review: &797 description: The review that was affected. type: object properties: @@ -205710,12 +205939,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -208084,7 +208313,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_reviewer: title: User type: @@ -208170,12 +208399,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -210551,7 +210780,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_team: title: Team description: Groups of organization members that gives permissions @@ -210746,12 +210975,12 @@ webhooks: type: string enum: - review_requested - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -213122,7 +213351,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_reviewer: title: User type: @@ -213209,12 +213438,12 @@ webhooks: type: string enum: - review_requested - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -215576,7 +215805,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_team: title: Team description: Groups of organization members that gives permissions @@ -215760,9 +215989,9 @@ webhooks: type: string enum: - submitted - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -218020,8 +218249,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 - review: *795 + repository: *750 + review: *797 sender: *4 required: - action @@ -218101,9 +218330,9 @@ webhooks: type: string enum: - resolved - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -220256,7 +220485,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 + repository: *750 sender: *4 thread: type: object @@ -220653,9 +220882,9 @@ webhooks: type: string enum: - unresolved - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -222791,7 +223020,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 + repository: *750 sender: *4 thread: type: object @@ -223124,7 +223353,7 @@ webhooks: - repository - organization - app - pull-request-synchronize: + pull-request-stacked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -223132,10 +223361,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request's head branch was updated. For example, the head - branch was updated from the base branch or new commits were pushed to the - head branch. - operationId: pull-request/synchronize + description: A pull request was added to a stack. + operationId: pull-request/stacked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -223179,21 +223406,17 @@ webhooks: content: application/json: schema: - title: pull_request synchronize event + title: pull_request stacked event type: object properties: action: type: string enum: - - synchronize - after: - type: string - before: - type: string - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + - stacked + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -224212,13 +224435,17 @@ webhooks: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -224433,15 +224660,23 @@ webhooks: master_branch: type: string merge_commit_message: - description: The default value for a merge commit message. + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: The default value for a merge commit message - title. + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string enum: - PR_TITLE @@ -224955,6 +225190,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -225550,13 +225786,11 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action - number - - before - - after - pull_request - repository - sender @@ -225572,7 +225806,7 @@ webhooks: - repository - organization - app - pull-request-unassigned: + pull-request-synchronize: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -225580,8 +225814,10 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A user was unassigned from a pull request. - operationId: pull-request/unassigned + description: A pull request's head branch was updated. For example, the head + branch was updated from the base branch or new commits were pushed to the + head branch. + operationId: pull-request/synchronize externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -225625,18 +225861,21 @@ webhooks: content: application/json: schema: - title: pull_request unassigned event + title: pull_request synchronize event type: object properties: action: type: string enum: - - unassigned - assignee: *796 - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + - synchronize + after: + type: string + before: + type: string + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -225998,9 +226237,664 @@ webhooks: type: object properties: label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User type: - - string + - object - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a + draft. + type: boolean + head: + type: object + properties: + label: + type: string ref: type: string repo: @@ -226221,684 +227115,15 @@ webhooks: master_branch: type: string merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: - - string - - 'null' - changed_files: - type: integer - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: - - string - - 'null' - ref: - type: string - repo: - title: Repository - description: A git repository - type: - - object - - 'null' - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. + description: The default value for a merge commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + description: The default value for a merge commit message + title. type: string enum: - PR_TITLE @@ -227412,7 +227637,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -228008,13 +228232,16 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action - number + - before + - after - pull_request - repository + - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -228027,7 +228254,7 @@ webhooks: - repository - organization - app - pull-request-unlabeled: + pull-request-unassigned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -228035,8 +228262,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was removed from a pull request. - operationId: pull-request/unlabeled + description: A user was unassigned from a pull request. + operationId: pull-request/unassigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -228080,18 +228307,18 @@ webhooks: content: application/json: schema: - title: pull_request unlabeled event + title: pull_request unassigned event type: object properties: action: type: string enum: - - unlabeled - enterprise: *745 - installation: *746 - label: *764 - number: *790 - organization: *747 + - unassigned + assignee: *798 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -228453,7 +228680,9 @@ webhooks: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: @@ -229335,15 +229564,23 @@ webhooks: master_branch: type: string merge_commit_message: - description: The default value for a merge commit message. + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: The default value for a merge commit message - title. + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string enum: - PR_TITLE @@ -229857,6 +230094,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -230452,14 +230690,13 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action - number - pull_request - repository - - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -230472,7 +230709,7 @@ webhooks: - repository - organization - app - pull-request-unlocked: + pull-request-unlabeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -230480,9 +230717,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was unlocked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/unlocked + description: A label was removed from a pull request. + operationId: pull-request/unlabeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -230526,17 +230762,18 @@ webhooks: content: application/json: schema: - title: pull_request unlocked event + title: pull_request unlabeled event type: object properties: action: type: string enum: - - unlocked - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + - unlabeled + enterprise: *747 + installation: *748 + label: *766 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -230700,6 +230937,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -230773,6 +231011,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -230806,7 +231045,9 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -231551,7 +231792,9 @@ webhooks: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: @@ -231774,23 +232017,15 @@ webhooks: master_branch: type: string merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. + description: The default value for a merge commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + description: The default value for a merge commit message + title. type: string enum: - PR_TITLE @@ -232392,6 +232627,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -232535,6 +232771,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -232646,6 +232883,15 @@ webhooks: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -232842,6 +233088,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -232887,7 +233134,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -232907,20 +233154,19 @@ webhooks: - repository - organization - app - push: + pull-request-unlocked: post: summary: |- - This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch - and tag deletions, use the [`delete`](#delete) webhook event. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. - operationId: push + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Conversation on a pull request was unlocked. For more information, + see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/unlocked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#push + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -232934,7 +233180,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: push + example: pull_request schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -232962,500 +233208,2936 @@ webhooks: content: application/json: schema: - title: push event + title: pull_request unlocked event type: object properties: - after: - description: The SHA of the most recent commit on `ref` after the - push. - type: string - base_ref: - type: - - string - - 'null' - before: - description: The SHA of the most recent commit on `ref` before the - push. - type: string - commits: - description: An array of commit objects describing the pushed commits. - (Pushed commits are all commits that are included in the `compare` - between the `before` commit and the `after` commit.) The array - includes a maximum of 2048 commits. If necessary, you can use - the [Commits API](https://docs.github.com/rest/commits) to fetch - additional commits. - type: array - items: - title: Commit - type: object - properties: - added: - description: An array of files added in the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that - have been pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - compare: - description: URL that shows the changes in this `ref` update, from - the `before` commit to the `after` commit. For a newly created - `ref` that is directly based on the default branch, this is the - comparison between the head of the default branch and the `after` - commit. Otherwise, this shows all commits until the `after` commit. - type: string - created: - description: Whether this push created the `ref`. - type: boolean - deleted: - description: Whether this push deleted the `ref`. - type: boolean - enterprise: *745 - forced: - description: Whether this push was a force push of the `ref`. - type: boolean - head_commit: - title: Commit - type: - - object - - 'null' - properties: - added: - description: An array of files added in the commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that have - been pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - installation: *746 - organization: *747 - pusher: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - name - ref: - description: 'The full git ref that was pushed. Example: `refs/heads/main` - or `refs/tags/v3.14.1`.' + action: type: string - repository: - title: Repository - description: A git repository + enum: + - unlocked + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: + title: Pull Request type: object properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: + _links: 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 - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create pull requests: - all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: type: - string - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: type: integer - organization: - type: string - owner: + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a + draft. + type: boolean + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull + request. + type: boolean + merge_commit_sha: + type: + - string + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within + its repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: + - boolean + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have + for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + repository: *750 + sender: *4 + required: + - action + - number + - pull_request + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app + push: + post: + summary: |- + This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, + when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch + and tag deletions, use the [`delete`](#delete) webhook event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + + > [!NOTE] + > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. + operationId: push + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#push + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: push + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: push event + type: object + properties: + after: + description: The SHA of the most recent commit on `ref` after the + push. + type: string + base_ref: + type: + - string + - 'null' + before: + description: The SHA of the most recent commit on `ref` before the + push. + type: string + commits: + description: An array of commit objects describing the pushed commits. + (Pushed commits are all commits that are included in the `compare` + between the `before` commit and the `after` commit.) The array + includes a maximum of 2048 commits. If necessary, you can use + the [Commits API](https://docs.github.com/rest/commits) to fetch + additional commits. + type: array + items: + title: Commit + type: object + properties: + added: + description: An array of files added in the commit. A maximum + of 3000 changed files will be reported per commit. + type: array + items: + type: string + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + distinct: + description: Whether this commit is distinct from any that + have been pushed before. + type: boolean + id: + type: string + message: + description: The commit message. + type: string + modified: + description: An array of files modified by the commit. A maximum + of 3000 changed files will be reported per commit. + type: array + items: + type: string + removed: + description: An array of files removed in the commit. A maximum + of 3000 changed files will be reported per commit. + type: array + items: + type: string + timestamp: + description: The ISO 8601 timestamp of the commit. + type: string + format: date-time + tree_id: + type: string + url: + description: URL that points to the commit API resource. + type: string + format: uri + required: + - id + - tree_id + - distinct + - message + - timestamp + - url + - author + - committer + compare: + description: URL that shows the changes in this `ref` update, from + the `before` commit to the `after` commit. For a newly created + `ref` that is directly based on the default branch, this is the + comparison between the head of the default branch and the `after` + commit. Otherwise, this shows all commits until the `after` commit. + type: string + created: + description: Whether this push created the `ref`. + type: boolean + deleted: + description: Whether this push deleted the `ref`. + type: boolean + enterprise: *747 + forced: + description: Whether this push was a force push of the `ref`. + type: boolean + head_commit: + title: Commit + type: + - object + - 'null' + properties: + added: + description: An array of files added in the commit. + type: array + items: + type: string + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + distinct: + description: Whether this commit is distinct from any that have + been pushed before. + type: boolean + id: + type: string + message: + description: The commit message. + type: string + modified: + description: An array of files modified by the commit. + type: array + items: + type: string + removed: + description: An array of files removed in the commit. + type: array + items: + type: string + timestamp: + description: The ISO 8601 timestamp of the commit. + type: string + format: date-time + tree_id: + type: string + url: + description: URL that points to the commit API resource. + type: string + format: uri + required: + - id + - tree_id + - distinct + - message + - timestamp + - url + - author + - committer + installation: *748 + organization: *749 + pusher: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - name + ref: + description: 'The full git ref that was pushed. Example: `refs/heads/main` + or `refs/tags/v3.14.1`.' + type: string + repository: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + 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 + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: title: User type: - object @@ -233785,9 +236467,9 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 registry_package: type: object properties: @@ -234264,7 +236946,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *779 + items: *781 summary: type: string tag_name: @@ -234320,7 +237002,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -234398,9 +237080,9 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 registry_package: type: object properties: @@ -234712,7 +237394,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *779 + items: *781 summary: type: string tag_name: @@ -234762,7 +237444,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -234839,10 +237521,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - release: &797 + enterprise: *747 + installation: *748 + organization: *749 + release: &799 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -235173,7 +237855,7 @@ webhooks: - updated_at - zipball_url - body - repository: *748 + repository: *750 sender: *4 required: - action @@ -235250,11 +237932,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - release: *797 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *799 + repository: *750 sender: *4 required: - action @@ -235371,11 +238053,11 @@ webhooks: type: boolean required: - to - enterprise: *745 - installation: *746 - organization: *747 - release: *797 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *799 + repository: *750 sender: *4 required: - action @@ -235453,9 +238135,9 @@ webhooks: type: string enum: - prereleased - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -235791,7 +238473,7 @@ webhooks: - string - 'null' format: uri - repository: *748 + repository: *750 sender: *4 required: - action @@ -235867,10 +238549,10 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 - release: &798 + enterprise: *747 + installation: *748 + organization: *749 + release: &800 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -236203,7 +238885,7 @@ webhooks: - string - 'null' format: uri - repository: *748 + repository: *750 sender: *4 required: - action @@ -236279,11 +238961,11 @@ webhooks: type: string enum: - released - enterprise: *745 - installation: *746 - organization: *747 - release: *797 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *799 + repository: *750 sender: *4 required: - action @@ -236359,11 +239041,11 @@ webhooks: type: string enum: - unpublished - enterprise: *745 - installation: *746 - organization: *747 - release: *798 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *800 + repository: *750 sender: *4 required: - action @@ -236439,11 +239121,11 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - repository_advisory: *666 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + repository_advisory: *668 sender: *4 required: - action @@ -236519,11 +239201,11 @@ webhooks: type: string enum: - reported - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - repository_advisory: *666 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + repository_advisory: *668 sender: *4 required: - action @@ -236599,10 +239281,10 @@ webhooks: type: string enum: - archived - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -236679,10 +239361,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -236760,10 +239442,10 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -236848,10 +239530,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -236966,10 +239648,10 @@ webhooks: - 'null' items: type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237041,10 +239723,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 status: type: string @@ -237125,10 +239807,10 @@ webhooks: type: string enum: - privatized - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237205,10 +239887,10 @@ webhooks: type: string enum: - publicized - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237302,10 +239984,10 @@ webhooks: - name required: - repository - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237385,10 +240067,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 repository_ruleset: *323 sender: *4 required: @@ -237467,10 +240149,10 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 repository_ruleset: *323 sender: *4 required: @@ -237549,10 +240231,10 @@ webhooks: type: string enum: - edited - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 repository_ruleset: *323 changes: type: object @@ -237860,10 +240542,10 @@ webhooks: - from required: - owner - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237941,10 +240623,10 @@ webhooks: type: string enum: - unarchived - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238022,7 +240704,7 @@ webhooks: type: string enum: - create - alert: &799 + alert: &801 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -238147,10 +240829,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238360,10 +241042,10 @@ webhooks: type: string enum: - dismissed - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238441,11 +241123,11 @@ webhooks: type: string enum: - reopen - alert: *799 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *801 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238647,10 +241329,10 @@ webhooks: enum: - fixed - open - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238728,7 +241410,7 @@ webhooks: type: string enum: - assigned - alert: &800 + alert: &803 type: object properties: number: *180 @@ -238867,11 +241549,12 @@ webhooks: anyOf: - type: 'null' - *4 + metadata: *802 assignee: *4 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238949,11 +241632,11 @@ webhooks: type: string enum: - created - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -239034,11 +241717,11 @@ webhooks: type: string enum: - created - alert: *800 - installation: *746 - location: *801 - organization: *747 - repository: *748 + alert: *803 + installation: *748 + location: *804 + organization: *749 + repository: *750 sender: *4 required: - location @@ -239216,6 +241899,168 @@ webhooks: - repository - organization - app + secret-scanning-alert-metadata-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: Metadata was created for a secret scanning alert. + operationId: secret-scanning-alert/metadata-created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: secret_scanning_alert + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + 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: secret_scanning_alert metadata created event + type: object + properties: + action: + type: string + enum: + - metadata_created + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-metadata-removed: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: Metadata was removed from a secret scanning alert. + operationId: secret-scanning-alert/metadata-removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: secret_scanning_alert + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + 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: secret_scanning_alert metadata removed event + type: object + properties: + action: + type: string + enum: + - metadata_removed + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-publicly-leaked: post: summary: |- @@ -239276,11 +242121,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -239358,11 +242203,11 @@ webhooks: type: string enum: - reopened - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -239440,11 +242285,11 @@ webhooks: type: string enum: - resolved - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -239522,12 +242367,12 @@ webhooks: type: string enum: - unassigned - alert: *800 + alert: *803 assignee: *4 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -239605,11 +242450,11 @@ webhooks: type: string enum: - validated - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -239739,10 +242584,10 @@ webhooks: - organization - enterprise - - repository: *748 - enterprise: *745 - installation: *746 - organization: *747 + repository: *750 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -239820,11 +242665,11 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - security_advisory: &802 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + security_advisory: &805 description: The details of the security advisory, including summary, description, and severity. type: object @@ -240010,11 +242855,11 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - security_advisory: *802 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + security_advisory: *805 sender: *4 required: - action @@ -240087,10 +242932,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -240277,9 +243122,9 @@ webhooks: type: object properties: security_and_analysis: *296 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: *340 sender: *4 required: @@ -240358,12 +243203,12 @@ webhooks: type: string enum: - cancelled - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: &803 + sponsorship: &806 type: object properties: created_at: @@ -240668,12 +243513,12 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - sponsorship @@ -240761,12 +243606,12 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - changes @@ -240843,17 +243688,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &804 + effective_date: &807 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - sponsorship @@ -240927,7 +243772,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &805 + changes: &808 type: object properties: tier: @@ -240971,13 +243816,13 @@ webhooks: - from required: - tier - effective_date: *804 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + effective_date: *807 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - changes @@ -241054,13 +243899,13 @@ webhooks: type: string enum: - tier_changed - changes: *805 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + changes: *808 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - changes @@ -241134,10 +243979,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -241221,10 +244066,10 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -241658,15 +244503,15 @@ webhooks: type: - string - 'null' - enterprise: *745 + enterprise: *747 id: description: The unique identifier of the status. type: integer - installation: *746 + installation: *748 name: type: string - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 sha: description: The Commit SHA. @@ -241782,9 +244627,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -241873,9 +244718,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -241964,9 +244809,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -242055,9 +244900,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -242133,12 +244978,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - team: &806 + team: &809 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -242368,9 +245213,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -242840,7 +245685,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -242916,9 +245761,9 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -243388,7 +246233,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -243465,9 +246310,9 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -243937,7 +246782,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -244081,9 +246926,9 @@ webhooks: - from required: - permissions - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -244553,7 +247398,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - changes @@ -244631,9 +247476,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -245103,7 +247948,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -245179,10 +248024,10 @@ webhooks: type: string enum: - started - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -245255,17 +248100,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *745 + enterprise: *747 inputs: type: - object - 'null' additionalProperties: true - installation: *746 - organization: *747 + installation: *748 + organization: *749 ref: type: string - repository: *748 + repository: *750 sender: *4 workflow: type: string @@ -245347,10 +248192,10 @@ webhooks: type: string enum: - completed - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: allOf: @@ -245685,10 +248530,10 @@ webhooks: type: string enum: - in_progress - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: allOf: @@ -246049,10 +248894,10 @@ webhooks: type: string enum: - queued - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: type: object @@ -246277,10 +249122,10 @@ webhooks: type: string enum: - waiting - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: type: object @@ -246507,12 +249352,12 @@ webhooks: type: string enum: - completed - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object @@ -247531,12 +250376,12 @@ webhooks: type: string enum: - in_progress - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object @@ -248540,12 +251385,12 @@ webhooks: type: string enum: - requested - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 9e7d568e42..e0ff2f5b5c 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -238099,6 +238099,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -239398,6 +239441,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -240771,6 +240857,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -242908,6 +243037,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -244232,6 +244404,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -245601,6 +245816,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -247190,6 +247448,24 @@ "schema": { "type": "boolean" } + }, + { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -652092,6 +652368,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -653958,6 +654277,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -655124,6 +655486,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -656503,6 +656908,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -658659,6 +659107,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -659840,6 +660331,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -661215,6 +661749,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -662820,6 +663397,24 @@ "schema": { "type": "boolean" } + }, + { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -665982,6 +666577,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -666010,7 +666627,13 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ] } } } @@ -667663,6 +668286,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -667711,6 +668356,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -1515797,11 +1516448,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-stacked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1515868,21 +1516519,15 @@ "content": { "application/json": { "schema": { - "title": "pull_request synchronize event", + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "synchronize" + "stacked" ] }, - "after": { - "type": "string" - }, - "before": { - "type": "string" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1517434,7 +1518079,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1517442,7 +1518090,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1517726,7 +1518377,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1517735,7 +1518386,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": [ "PR_TITLE", @@ -1518391,7 +1519042,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1520849,8 +1521501,6 @@ "required": [ "action", "number", - "before", - "after", "pull_request", "repository", "sender" @@ -1520876,11 +1521526,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1520947,114 +1521597,20 @@ "content": { "application/json": { "schema": { - "title": "pull_request unassigned event", + "title": "pull_request synchronize event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unassigned" + "synchronize" ] }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "after": { + "type": "string" + }, + "before": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -1521770,10 +1522326,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1522610,10 +1523163,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1522621,10 +1523171,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1522908,7 +1523455,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1522917,7 +1523464,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1523573,8 +1524120,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -1526032,8 +1526578,11 @@ "required": [ "action", "number", + "before", + "after", "pull_request", - "repository" + "repository", + "sender" ] } } @@ -1526056,11 +1526605,11 @@ } } }, - "pull-request-unlabeled": { + "pull-request-unassigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1526127,13 +1526676,113 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlabeled event", + "title": "pull_request unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" + "unassigned" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -1526251,49 +1526900,6 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "number": { "description": "The pull request number.", "type": "integer" @@ -1526893,7 +1527499,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1528028,7 +1528637,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1528037,7 +1528646,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": [ "PR_TITLE", @@ -1528693,7 +1529302,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1531152,8 +1531762,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ] } } @@ -1531176,11 +1531785,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1531247,13 +1531856,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlocked event", + "title": "pull_request unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlocked" + "unlabeled" ] }, "enterprise": { @@ -1531371,6 +1531980,49 @@ "node_id" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "number": { "description": "The pull request number.", "type": "integer" @@ -1531696,7 +1532348,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1531797,7 +1532450,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1531843,7 +1532497,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -1532802,7 +1533459,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1533097,7 +1533757,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1533106,7 +1533766,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1533883,7 +1534543,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1534077,7 +1534738,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1534225,7 +1534887,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -1534488,7 +1535159,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1536233,12 +1536905,13 @@ } } }, - "push": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1536260,7 +1536933,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "push", + "example": "pull_request", "schema": { "type": "string" } @@ -1536303,158 +1536976,15 @@ "content": { "application/json": { "schema": { - "title": "push event", + "title": "pull_request unlocked event", "type": "object", "properties": { - "after": { - "description": "The SHA of the most recent commit on `ref` after the push.", - "type": "string" - }, - "base_ref": { - "type": [ - "string", - "null" + "action": { + "type": "string", + "enum": [ + "unlocked" ] }, - "before": { - "description": "The SHA of the most recent commit on `ref` before the push.", - "type": "string" - }, - "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits.", - "type": "array", - "items": { - "title": "Commit", - "type": "object", - "properties": { - "added": { - "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "distinct": { - "description": "Whether this commit is distinct from any that have been pushed before.", - "type": "boolean" - }, - "id": { - "type": "string" - }, - "message": { - "description": "The commit message.", - "type": "string" - }, - "modified": { - "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "removed": { - "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "timestamp": { - "description": "The ISO 8601 timestamp of the commit.", - "type": "string", - "format": "date-time" - }, - "tree_id": { - "type": "string" - }, - "url": { - "description": "URL that points to the commit API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "tree_id", - "distinct", - "message", - "timestamp", - "url", - "author", - "committer" - ] - } - }, - "compare": { - "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.", - "type": "string" - }, - "created": { - "description": "Whether this push created the `ref`.", - "type": "boolean" - }, - "deleted": { - "description": "Whether this push deleted the `ref`.", - "type": "boolean" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1536545,132 +1537075,6 @@ "avatar_url" ] }, - "forced": { - "description": "Whether this push was a force push of the `ref`.", - "type": "boolean" - }, - "head_commit": { - "title": "Commit", - "type": [ - "object", - "null" - ], - "properties": { - "added": { - "description": "An array of files added in the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "distinct": { - "description": "Whether this commit is distinct from any that have been pushed before.", - "type": "boolean" - }, - "id": { - "type": "string" - }, - "message": { - "description": "The commit message.", - "type": "string" - }, - "modified": { - "description": "An array of files modified by the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "removed": { - "description": "An array of files removed in the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "timestamp": { - "description": "The ISO 8601 timestamp of the commit.", - "type": "string", - "format": "date-time" - }, - "tree_id": { - "type": "string" - }, - "url": { - "description": "URL that points to the commit API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "tree_id", - "distinct", - "message", - "timestamp", - "url", - "author", - "committer" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1536696,6 +1537100,10 @@ "node_id" ] }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1536795,365 +1537203,146 @@ "description" ] }, - "pusher": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "ref": { - "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.", - "type": "string" - }, - "repository": { - "title": "Repository", - "description": "A git repository", + "pull_request": { + "title": "Pull Request", "type": "object", "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "custom_properties": { + "_links": { "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 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "type": "boolean", - "default": true - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], "properties": { - "key": { - "type": "string" + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "name": { - "type": "string" + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "node_id": { - "type": "string" + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "spdx_id": { - "type": "string" + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] } }, "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" ] }, - "master_branch": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { + "active_lock_reason": { "type": [ "string", "null" ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, - "open_issues_count": { + "additions": { "type": "integer" }, - "organization": { - "type": "string" - }, - "owner": { + "assignee": { "title": "User", "type": [ "object", @@ -1537252,864 +1537441,181 @@ "id" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { + "assignees": { "type": "array", "items": { - "type": "string" + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] } }, - "trees_url": { - "type": "string", - "format": "uri-template" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "visibility": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", "enum": [ - "public", - "private", - "internal" - ] - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private", - "owner", - "html_url", - "description", - "fork", - "url", - "forks_url", - "keys_url", - "collaborators_url", - "teams_url", - "hooks_url", - "issue_events_url", - "events_url", - "assignees_url", - "branches_url", - "tags_url", - "blobs_url", - "git_tags_url", - "git_refs_url", - "trees_url", - "statuses_url", - "languages_url", - "stargazers_url", - "contributors_url", - "subscribers_url", - "subscription_url", - "commits_url", - "git_commits_url", - "comments_url", - "issue_comment_url", - "contents_url", - "compare_url", - "merges_url", - "archive_url", - "downloads_url", - "issues_url", - "pulls_url", - "milestones_url", - "notifications_url", - "labels_url", - "releases_url", - "deployments_url", - "created_at", - "updated_at", - "pushed_at", - "git_url", - "ssh_url", - "clone_url", - "svn_url", - "homepage", - "size", - "stargazers_count", - "watchers_count", - "language", - "has_issues", - "has_projects", - "has_downloads", - "has_wiki", - "has_pages", - "has_discussions", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] - }, - "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": [ - "ref", - "before", - "after", - "created", - "deleted", - "forced", - "base_ref", - "compare", - "commits", - "head_commit", - "repository", - "pusher" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "push", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "registry-package-published": { - "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" - }, - "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": "registry_package", - "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": { - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "published" - ] - }, - "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" - ] - }, - "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" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "description": { + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", "type": [ - "string", + "object", "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" - ] - }, - "registry_package": { - "type": "object", - "properties": { - "created_at": { - "type": [ - "string", - "null" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "owner": { - "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" - }, - "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" + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] }, - "url": { + "commit_title": { + "description": "Title for the merge commit message.", "type": "string" }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" - ] - }, - "package_type": { - "type": "string" - }, - "package_version": { - "type": [ - "object", - "null" - ], - "properties": { - "author": { - "type": "object", + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1538117,32 +1537623,46 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" @@ -1538150,469 +1537670,415 @@ }, "required": [ "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" + "id" ] }, - "body": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - "body_html": { + "ref": { "type": "string" }, - "container_metadata": { + "repo": { + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { - "labels": { - "type": [ - "object", - "null" - ] + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false }, - "manifest": { - "type": [ - "object", - "null" - ] + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" }, - "tag": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - } - }, - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "docker_metadata": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "installation_command": { - "type": "string" - }, - "manifest": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - }, - "name": { - "type": "string" - }, - "npm_metadata": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true }, - "version": { - "type": "string" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true }, - "npm_user": { - "type": "string" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true }, - "author": { + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { "oneOf": [ { - "type": "string" + "type": "integer" }, { - "type": "object" + "type": "string", + "format": "date-time" } - ], - "type": [ - "null", - "string", - "object" ] }, - "bugs": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { "type": [ - "null", "string", - "object" + "null" ] }, - "dependencies": { - "type": "object" + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" }, - "dev_dependencies": { - "type": "object" + "downloads_url": { + "type": "string", + "format": "uri" }, - "peer_dependencies": { - "type": "object" + "events_url": { + "type": "string", + "format": "uri" }, - "optional_dependencies": { - "type": "object" + "fork": { + "type": "boolean" }, - "description": { - "type": "string" + "forks": { + "type": "integer" }, - "dist": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], - "type": [ - "null", - "string", - "object" - ] + "forks_count": { + "type": "integer" }, - "git_head": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri" }, - "homepage": { + "full_name": { "type": "string" }, - "license": { - "type": "string" + "git_commits_url": { + "type": "string", + "format": "uri-template" }, - "main": { - "type": "string" + "git_refs_url": { + "type": "string", + "format": "uri-template" }, - "repository": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { "type": [ - "null", "string", - "object" + "null" ] }, - "scripts": { - "type": "object" - }, - "id": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri" }, - "node_version": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "npm_version": { - "type": "string" + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" }, - "has_shrinkwrap": { + "is_template": { "type": "boolean" }, - "maintainers": { - "type": "array", - "items": { - "type": "string" - } + "issue_comment_url": { + "type": "string", + "format": "uri-template" }, - "contributors": { - "type": "array", - "items": { - "type": "string" - } + "issue_events_url": { + "type": "string", + "format": "uri-template" }, - "engines": { - "type": "object" + "issues_url": { + "type": "string", + "format": "uri-template" }, - "keywords": { - "type": "array", - "items": { - "type": "string" - } + "keys_url": { + "type": "string", + "format": "uri-template" }, - "files": { - "type": "array", - "items": { - "type": "string" - } + "labels_url": { + "type": "string", + "format": "uri-template" }, - "bin": { - "type": "object" + "language": { + "type": [ + "string", + "null" + ] }, - "man": { - "type": "object" + "languages_url": { + "type": "string", + "format": "uri" }, - "directories": { - "oneOf": [ - { + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { "type": "string" }, - { - "type": "object" + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } - ], - "type": [ - "null", - "string", - "object" + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" ] }, - "os": { - "type": "array", - "items": { - "type": "string" - } + "master_branch": { + "type": "string" }, - "cpu": { - "type": "array", - "items": { - "type": "string" - } + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] }, - "readme": { + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", "type": "string" }, - "installation_command": { + "node_id": { "type": "string" }, - "release_id": { + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { "type": "integer" }, - "commit_oid": { - "type": "string" + "open_issues_count": { + "type": "integer" }, - "published_via_actions": { - "type": "boolean" + "organization": { + "type": "string" }, - "deleted_by_id": { - "type": "integer" - } - } - }, - "nuget_metadata": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "object", - "integer" - ] - }, - "name": { - "type": "string" - }, - "value": { - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "branch": { - "type": "string" - }, - "commit": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - ] - } - } - } - }, - "package_files": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "md5": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "sha1": { - "type": [ - "string", - "null" - ] - }, - "sha256": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "state": { - "type": [ - "string", - "null" - ] - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "download_url", - "id", - "name", - "sha256", - "sha1", - "md5", - "content_type", - "state", - "size", - "created_at", - "updated_at" - ] - } - }, - "package_url": { - "type": "string" - }, - "prerelease": { - "type": "boolean" - }, - "release": { - "type": "object", - "properties": { - "author": { - "type": "object", + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1538620,510 +1538086,1341 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, - "created_at": { - "type": "string" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] }, - "draft": { + "private": { + "description": "Whether the repository is private or public.", "type": "boolean" }, - "html_url": { + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { "type": "string" }, - "id": { + "stargazers": { "type": "integer" }, - "name": { + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" ] }, - "prerelease": { - "type": "boolean" + "events_url": { + "type": "string", + "format": "uri-template" }, - "published_at": { + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "tag_name": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { "type": "string" }, - "target_commitish": { + "name": { + "type": "string" + }, + "node_id": { "type": "string" }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { "type": "string" } - } - }, - "rubygems_metadata": { - "type": "array", - "items": { - "title": "Ruby Gems metadata", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "readme": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "version_info": { - "type": "object", - "properties": { - "version": { - "type": "string" - } - } - }, - "platform": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repo": { - "type": "string" - }, - "dependencies": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "commit_oid": { - "type": "string" - } - } - } - }, - "summary": { - "type": "string" - }, - "tag_name": { - "type": "string" - }, - "target_commitish": { - "type": "string" - }, - "target_oid": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "version": { - "type": "string" + }, + "required": [ + "login", + "id" + ] } }, "required": [ - "id", - "version", - "name", - "description", - "summary", - "html_url", - "metadata", - "package_files", - "installation_command", - "package_url" + "label", + "ref", + "sha", + "user", + "repo" ] }, - "registry": { + "body": { "type": [ - "object", + "string", "null" - ], - "properties": { - "about_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - }, - "vendor": { - "type": "string" - } - } + ] }, - "updated_at": { + "changed_files": { + "type": "integer" + }, + "closed_at": { "type": [ "string", "null" - ] - } - }, - "required": [ - "id", - "name", - "namespace", - "description", - "ecosystem", - "package_type", - "html_url", - "created_at", - "updated_at", - "owner", - "package_version", - "registry" - ] - }, - "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 - ] + ], + "format": "date-time" }, - "node_id": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "format": "uri" }, - "name": { - "description": "The name of the repository.", + "commits": { + "type": "integer" + }, + "commits_url": { "type": "string", - "examples": [ - "Team Environment" - ] + "format": "uri" }, - "full_name": { + "created_at": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "format": "date-time" }, - "license": { - "anyOf": [ - { - "type": "null" + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], "properties": { - "key": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { "type": "string", - "examples": [ - "mit" - ] + "format": "uri-template" }, - "name": { + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { "type": "string", - "examples": [ - "MIT License" + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } ] }, - "url": { + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" ] }, - "spdx_id": { + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { "type": [ "string", "null" - ], - "examples": [ - "MIT" ] }, - "node_id": { + "hooks_url": { "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "format": "uri" }, "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": { + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { "type": [ "string", "null" ] }, - "email": { + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", "type": [ - "string", + "object", "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" ] }, - "login": { + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", - "examples": [ - "octocat" + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" ] }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" ] }, - "node_id": { + "merges_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri" }, - "avatar_url": { + "milestones_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, - "gravatar_id": { + "mirror_url": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "format": "uri" }, - "url": { + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" ] }, - "followers_url": { + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" ] }, - "following_url": { + "releases_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" ] }, - "gists_url": { + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" ] }, - "starred_url": { + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" ] }, - "subscriptions_url": { + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "statuses_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" ] }, - "repos_url": { + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" ] }, "events_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "uri" }, - "type": { + "repos_url": { "type": "string", - "examples": [ - "User" - ] + "format": "uri" }, "site_admin": { "type": "boolean" }, - "starred_at": { + "starred_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri-template" }, - "user_view_type": { + "subscriptions_url": { "type": "string", - "examples": [ - "public" + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "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" + "id" ] } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" ] }, - "forks": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "mergeable": { + "type": [ + "boolean", + "null" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" }, "email": { "type": [ @@ -1539131,234 +1539428,1392 @@ "null" ] }, - "login": { + "events_url": { "type": "string", - "examples": [ - "octocat" - ] + "format": "uri-template" }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "following_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "format": "uri" }, - "following_url": { + "received_events_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "format": "uri" }, - "gists_url": { + "repos_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "format": "uri" + }, + "site_admin": { + "type": "boolean" }, "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "format": "uri-template" }, "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "repos_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "description": { + "type": [ + "string", + "null" ] }, - "type": { + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { "type": "string", - "examples": [ - "User" - ] + "format": "uri" }, - "site_admin": { - "type": "boolean" + "id": { + "type": "integer" }, - "starred_at": { + "labels_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" }, - "user_view_type": { + "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", - "examples": [ - "public" + "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": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "url", "html_url", + "labels_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "node_id": { + "type": "string" }, - "html_url": { + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "format": "uri" }, - "description": { + "rebaseable": { "type": [ - "string", + "boolean", "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}" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { @@ -1540481,7 +1541936,9 @@ }, "required": [ "action", - "registry_package", + "number", + "pull_request", + "repository", "sender" ] } @@ -1540496,7 +1541953,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -1540505,13 +1541962,12 @@ } } }, - "registry-package-updated": { + "push": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1540533,7 +1541989,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "registry_package", + "example": "push", "schema": { "type": "string" } @@ -1540576,14 +1542032,158 @@ "content": { "application/json": { "schema": { + "title": "push event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "updated" + "after": { + "description": "The SHA of the most recent commit on `ref` after the push.", + "type": "string" + }, + "base_ref": { + "type": [ + "string", + "null" ] }, + "before": { + "description": "The SHA of the most recent commit on `ref` before the push.", + "type": "string" + }, + "commits": { + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits.", + "type": "array", + "items": { + "title": "Commit", + "type": "object", + "properties": { + "added": { + "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + } + }, + "compare": { + "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.", + "type": "string" + }, + "created": { + "description": "Whether this push created the `ref`.", + "type": "boolean" + }, + "deleted": { + "description": "Whether this push deleted the `ref`.", + "type": "boolean" + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1540674,6 +1542274,132 @@ "avatar_url" ] }, + "forced": { + "description": "Whether this push was a force push of the `ref`.", + "type": "boolean" + }, + "head_commit": { + "title": "Commit", + "type": [ + "object", + "null" + ], + "properties": { + "added": { + "description": "An array of files added in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1540798,55 +1542524,406 @@ "description" ] }, - "registry_package": { + "pusher": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "ref": { + "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.", + "type": "string" + }, + "repository": { + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "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 + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string" }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, "description": { "type": [ + "string", "null" ] }, - "ecosystem": { + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { "type": "string" }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { - "type": "integer" + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, "name": { + "description": "The name of the repository.", "type": "string" }, - "namespace": { + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { "type": "string" }, "owner": { - "type": "object", + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1540854,32 +1542931,46 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" @@ -1540887,237 +1542978,1361 @@ }, "required": [ "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" + "id" ] }, - "package_type": { - "type": "string" - }, - "package_version": { + "permissions": { "type": "object", "properties": { - "author": { - "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" - }, - "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": [ - "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" - ] - }, - "body": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "docker_metadata": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ], - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "draft": { + "admin": { "type": "boolean" }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "installation_command": { - "type": "string" - }, - "manifest": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - }, - "name": { - "type": "string" + "maintain": { + "type": "boolean" }, - "package_files": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "md5": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "sha1": { - "type": [ - "string", - "null" - ] - }, - "sha256": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } + "pull": { + "type": "boolean" }, - "package_url": { - "type": "string" + "push": { + "type": "boolean" }, - "prerelease": { + "triage": { "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" }, - "release": { - "type": "object", - "properties": { - "author": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "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": [ + "ref", + "before", + "after", + "created", + "deleted", + "forced", + "base_ref", + "compare", + "commits", + "head_commit", + "repository", + "pusher" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "push", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "registry-package-published": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + }, + "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": "registry_package", + "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": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" + ] + }, + "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" + ] + }, + "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" + ] + }, + "registry_package": { + "type": "object", + "properties": { + "created_at": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { + "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" + }, + "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": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "package_type": { + "type": "string" + }, + "package_version": { + "type": [ + "object", + "null" + ], + "properties": { + "author": { + "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" + }, + "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": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "body": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "body_html": { + "type": "string" + }, + "container_metadata": { + "type": "object", + "properties": { + "labels": { + "type": [ + "object", + "null" + ] + }, + "manifest": { + "type": [ + "object", + "null" + ] + }, + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "npm_metadata": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "npm_user": { + "type": "string" + }, + "author": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "bugs": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "dependencies": { + "type": "object" + }, + "dev_dependencies": { + "type": "object" + }, + "peer_dependencies": { + "type": "object" + }, + "optional_dependencies": { + "type": "object" + }, + "description": { + "type": "string" + }, + "dist": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "git_head": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "license": { + "type": "string" + }, + "main": { + "type": "string" + }, + "repository": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "scripts": { + "type": "object" + }, + "id": { + "type": "string" + }, + "node_version": { + "type": "string" + }, + "npm_version": { + "type": "string" + }, + "has_shrinkwrap": { + "type": "boolean" + }, + "maintainers": { + "type": "array", + "items": { + "type": "string" + } + }, + "contributors": { + "type": "array", + "items": { + "type": "string" + } + }, + "engines": { + "type": "object" + }, + "keywords": { + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + }, + "bin": { + "type": "object" + }, + "man": { + "type": "object" + }, + "directories": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "os": { + "type": "array", + "items": { + "type": "string" + } + }, + "cpu": { + "type": "array", + "items": { + "type": "string" + } + }, + "readme": { + "type": "string" + }, + "installation_command": { + "type": "string" + }, + "release_id": { + "type": "integer" + }, + "commit_oid": { + "type": "string" + }, + "published_via_actions": { + "type": "boolean" + }, + "deleted_by_id": { + "type": "integer" + } + } + }, + "nuget_metadata": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "object", + "integer" + ] + }, + "name": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "commit": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + ] + } + } + } + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "sha1": { + "type": [ + "string", + "null" + ] + }, + "sha256": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "state": { + "type": [ + "string", + "null" + ] + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "download_url", + "id", + "name", + "sha256", + "sha1", + "md5", + "content_type", + "state", + "size", + "created_at", + "updated_at" + ] + } + }, + "package_url": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "release": { + "type": "object", + "properties": { + "author": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" }, "gists_url": { "type": "string" @@ -1541164,27 +1544379,7 @@ "user_view_type": { "type": "string" } - }, - "required": [ - "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" - ] + } }, "created_at": { "type": "string" @@ -1541199,7 +1544394,10 @@ "type": "integer" }, "name": { - "type": "string" + "type": [ + "string", + "null" + ] }, "prerelease": { "type": "boolean" @@ -1541216,20 +1544414,7 @@ "url": { "type": "string" } - }, - "required": [ - "url", - "html_url", - "id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "created_at", - "published_at" - ] + } }, "rubygems_metadata": { "type": "array", @@ -1541309,16 +1544494,9 @@ "name", "description", "summary", - "body", - "body_html", "html_url", - "target_commitish", - "target_oid", - "created_at", - "updated_at", "metadata", "package_files", - "author", "installation_command", "package_url" ] @@ -1541327,10 +1544505,30 @@ "type": [ "object", "null" - ] + ], + "properties": { + "about_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "vendor": { + "type": "string" + } + } }, "updated_at": { - "type": "string" + "type": [ + "string", + "null" + ] } }, "required": [ @@ -1543036,13 +1546234,13 @@ } } }, - "release-created": { + "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -1543064,7 +1546262,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -1543107,13 +1546305,12 @@ "content": { "application/json": { "schema": { - "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "updated" ] }, "enterprise": { @@ -1543330,232 +1546527,55 @@ "description" ] }, - "release": { - "title": "Release", - "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "registry_package": { "type": "object", "properties": { - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "download_count": { - "type": "integer" - }, - "id": { - "type": "integer" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ] - } - }, - "assets_url": { - "type": "string", - "format": "uri" + "created_at": { + "type": "string" }, - "author": { - "title": "User", + "description": { "type": [ - "object", "null" - ], + ] + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { + "type": "object", "properties": { "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] + "type": "string" }, "events_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "followers_url": { - "type": "string", - "format": "uri" + "type": "string" }, "following_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gists_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" @@ -1543563,46 +1546583,32 @@ "login": { "type": "string" }, - "name": { - "type": "string" - }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string", - "format": "uri" + "type": "string" }, "received_events_url": { - "type": "string", - "format": "uri" + "type": "string" }, "repos_url": { - "type": "string", - "format": "uri" + "type": "string" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "subscriptions_url": { - "type": "string", - "format": "uri" + "type": "string" }, "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "type": "string" }, "url": { - "type": "string", - "format": "uri" + "type": "string" }, "user_view_type": { "type": "string" @@ -1543610,372 +1546616,668 @@ }, "required": [ "login", - "id" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri" - }, - "draft": { - "description": "Whether the release is a draft or published", - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" ] }, - "node_id": { + "package_type": { "type": "string" }, - "prerelease": { - "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "reactions": { - "title": "Reactions", + "package_version": { "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" - ] - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, - "url": { - "type": "string", - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "assets_url", - "upload_url", - "html_url", - "id", - "node_id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "immutable", - "created_at", - "published_at", - "assets", - "tarball_url", - "updated_at", - "zipball_url", - "body" - ] - }, - "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", + "author": { "type": "object", "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] + "avatar_url": { + "type": "string" }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] + "events_url": { + "type": "string" }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] + "followers_url": { + "type": "string" }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "following_url": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" }, "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" - ] + "type": "string" }, - "email": { - "type": [ - "string", - "null" - ] + "id": { + "type": "integer" }, "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "type": "string" }, "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" - ] + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "organizations_url": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "received_events_url": { + "type": "string" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "repos_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "site_admin": { + "type": "boolean" }, "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "type": "string" }, "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ], + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "sha1": { + "type": [ + "string", + "null" + ] + }, + "sha256": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "package_url": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "release": { + "type": "object", + "properties": { + "author": { + "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" + }, + "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": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "required": [ + "url", + "html_url", + "id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "created_at", + "published_at" + ] + }, + "rubygems_metadata": { + "type": "array", + "items": { + "title": "Ruby Gems metadata", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "readme": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "version_info": { + "type": "object", + "properties": { + "version": { + "type": "string" + } + } + }, + "platform": { + "type": "string" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repo": { + "type": "string" + }, + "dependencies": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "commit_oid": { + "type": "string" + } + } + } + }, + "summary": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "target_oid": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "required": [ + "id", + "version", + "name", + "description", + "summary", + "body", + "body_html", + "html_url", + "target_commitish", + "target_oid", + "created_at", + "updated_at", + "metadata", + "package_files", + "author", + "installation_command", + "package_url" + ] + }, + "registry": { + "type": [ + "object", + "null" + ] + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", + "created_at", + "updated_at", + "owner", + "package_version", + "registry" + ] + }, + "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" ] }, @@ -1545439,8 +1548741,7 @@ }, "required": [ "action", - "release", - "repository", + "registry_package", "sender" ] } @@ -1545455,7 +1548756,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -1545464,11 +1548765,11 @@ } } }, - "release-deleted": { + "release-created": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1545535,13 +1548836,13 @@ "content": { "application/json": { "schema": { - "title": "release deleted event", + "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "created" ] }, "enterprise": { @@ -1547892,11 +1551193,11 @@ } } }, - "release-edited": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "description": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1547963,68 +1551264,15 @@ "content": { "application/json": { "schema": { - "title": "release edited event", + "title": "release deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "deleted" ] }, - "changes": { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "name": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the name if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "tag_name": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the tag_name if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "make_latest": { - "type": "object", - "properties": { - "to": { - "description": "Whether this release was explicitly `edited` to be the latest.", - "type": "boolean" - } - }, - "required": [ - "to" - ] - } - } - }, "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).\"", @@ -1550348,9 +1553596,9 @@ }, "required": [ "action", - "changes", "release", - "repository" + "repository", + "sender" ] } } @@ -1550373,11 +1553621,11 @@ } } }, - "release-prereleased": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1550444,15 +1553692,68 @@ "content": { "application/json": { "schema": { - "title": "release prereleased event", + "title": "release edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "prereleased" + "edited" ] }, + "changes": { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "tag_name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the tag_name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "make_latest": { + "type": "object", + "properties": { + "to": { + "description": "Whether this release was explicitly `edited` to be the latest.", + "type": "boolean" + } + }, + "required": [ + "to" + ] + } + } + }, "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).\"", @@ -1550671,53 +1553972,13 @@ "title": "Release", "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", "type": "object", - "required": [ - "assets", - "assets_url", - "author", - "body", - "created_at", - "draft", - "html_url", - "id", - "immutable", - "name", - "node_id", - "prerelease", - "published_at", - "tag_name", - "tarball_url", - "target_commitish", - "updated_at", - "upload_url", - "url", - "zipball_url" - ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": [ - "object", - "null" - ], - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ], + "type": "object", "properties": { "browser_download_url": { "type": "string", @@ -1550775,10 +1554036,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1550863,13 +1554120,32 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "login", + "id" + ] }, "url": { "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "digest", + "content_type", + "size", + "download_count", + "created_at", + "updated_at" + ] } }, "assets_url": { @@ -1550882,10 +1554158,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1550973,7 +1554245,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": [ @@ -1550988,6 +1554264,13 @@ ], "format": "date-time" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1551018,10 +1554301,7 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean", - "enum": [ - true - ] + "type": "boolean" }, "published_at": { "type": [ @@ -1551033,18 +1554313,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1551077,7 +1554345,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "tag_name": { "description": "The name of the tag.", @@ -1551098,13 +1554378,6 @@ "type": "string", "format": "uri-template" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "url": { "type": "string", "format": "uri" @@ -1551116,7 +1554389,29 @@ ], "format": "uri" } - } + }, + "required": [ + "url", + "assets_url", + "upload_url", + "html_url", + "id", + "node_id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "immutable", + "created_at", + "published_at", + "assets", + "tarball_url", + "updated_at", + "zipball_url", + "body" + ] }, "repository": { "title": "Repository", @@ -1552782,6 +1556077,7 @@ }, "required": [ "action", + "changes", "release", "repository" ] @@ -1552806,11 +1556102,11 @@ } } }, - "release-published": { + "release-prereleased": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1552877,13 +1556173,13 @@ "content": { "application/json": { "schema": { - "title": "release published event", + "title": "release prereleased event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "prereleased" ] }, "enterprise": { @@ -1553113,10 +1556409,10 @@ "draft", "html_url", "id", + "immutable", "name", "node_id", "prerelease", - "immutable", "published_at", "tag_name", "tarball_url", @@ -1553144,9 +1556440,9 @@ "name", "label", "state", + "digest", "content_type", "size", - "digest", "download_count", "created_at", "updated_at" @@ -1553451,7 +1556747,10 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" + "type": "boolean", + "enum": [ + true + ] }, "published_at": { "type": [ @@ -1553524,6 +1556823,10 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, "updated_at": { "type": [ "string", @@ -1553531,10 +1556834,6 @@ ], "format": "date-time" }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, "url": { "type": "string", "format": "uri" @@ -1555236,11 +1558535,11 @@ } } }, - "release-released": { + "release-published": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1555307,13 +1558606,13 @@ "content": { "application/json": { "schema": { - "title": "release released event", + "title": "release published event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "released" + "published" ] }, "enterprise": { @@ -1555534,13 +1558833,53 @@ "title": "Release", "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", "type": "object", + "required": [ + "assets", + "assets_url", + "author", + "body", + "created_at", + "draft", + "html_url", + "id", + "name", + "node_id", + "prerelease", + "immutable", + "published_at", + "tag_name", + "tarball_url", + "target_commitish", + "updated_at", + "upload_url", + "url", + "zipball_url" + ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": "object", + "type": [ + "object", + "null" + ], + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], "properties": { "browser_download_url": { "type": "string", @@ -1555598,6 +1558937,10 @@ "object", "null" ], + "required": [ + "login", + "id" + ], "properties": { "avatar_url": { "type": "string", @@ -1555682,32 +1559025,13 @@ "type": "string", "format": "uri" } - }, - "required": [ - "login", - "id" - ] + } }, "url": { "type": "string", "format": "uri" } - }, - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ] + } } }, "assets_url": { @@ -1555720,6 +1559044,10 @@ "object", "null" ], + "required": [ + "login", + "id" + ], "properties": { "avatar_url": { "type": "string", @@ -1555807,11 +1559135,7 @@ "user_view_type": { "type": "string" } - }, - "required": [ - "login", - "id" - ] + } }, "body": { "type": [ @@ -1555826,13 +1559150,6 @@ ], "format": "date-time" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "discussion_url": { "type": "string", "format": "uri" @@ -1555875,6 +1559192,18 @@ "reactions": { "title": "Reactions", "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], "properties": { "+1": { "type": "integer" @@ -1555907,19 +1559236,7 @@ "type": "string", "format": "uri" } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + } }, "tag_name": { "description": "The name of the tag.", @@ -1555936,6 +1559253,13 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "upload_url": { "type": "string", "format": "uri-template" @@ -1555951,29 +1559275,7 @@ ], "format": "uri" } - }, - "required": [ - "url", - "assets_url", - "upload_url", - "html_url", - "id", - "node_id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "immutable", - "created_at", - "published_at", - "assets", - "tarball_url", - "updated_at", - "zipball_url", - "body" - ] + } }, "repository": { "title": "Repository", @@ -1557663,11 +1560965,11 @@ } } }, - "release-unpublished": { + "release-released": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release or pre-release was unpublished.", - "operationId": "release/unpublished", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1557734,13 +1561036,13 @@ "content": { "application/json": { "schema": { - "title": "release unpublished event", + "title": "release released event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unpublished" + "released" ] }, "enterprise": { @@ -1557961,53 +1561263,13 @@ "title": "Release", "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", "type": "object", - "required": [ - "assets", - "assets_url", - "author", - "body", - "created_at", - "draft", - "html_url", - "id", - "name", - "node_id", - "prerelease", - "immutable", - "published_at", - "tag_name", - "tarball_url", - "target_commitish", - "updated_at", - "upload_url", - "url", - "zipball_url" - ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": [ - "object", - "null" - ], - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "content_type", - "size", - "digest", - "download_count", - "created_at", - "updated_at" - ], + "type": "object", "properties": { "browser_download_url": { "type": "string", @@ -1558065,10 +1561327,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1558153,13 +1561411,32 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "login", + "id" + ] }, "url": { "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "digest", + "content_type", + "size", + "download_count", + "created_at", + "updated_at" + ] } }, "assets_url": { @@ -1558172,10 +1561449,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1558263,7 +1561536,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": [ @@ -1558278,6 +1561555,13 @@ ], "format": "date-time" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1558320,18 +1561604,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1558364,7 +1561636,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "tag_name": { "description": "The name of the tag.", @@ -1558381,13 +1561665,6 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "upload_url": { "type": "string", "format": "uri-template" @@ -1558403,7 +1561680,29 @@ ], "format": "uri" } - } + }, + "required": [ + "url", + "assets_url", + "upload_url", + "html_url", + "id", + "node_id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "immutable", + "created_at", + "published_at", + "assets", + "tarball_url", + "updated_at", + "zipball_url", + "body" + ] }, "repository": { "title": "Repository", @@ -1560093,13 +1563392,13 @@ } } }, - "repository-advisory-published": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A repository security advisory was published.", - "operationId": "repository-advisory/published", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1560121,7 +1563420,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -1560164,13 +1563463,2443 @@ "content": { "application/json": { "schema": { - "title": "Repository advisory published event", + "title": "release unpublished event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "unpublished" + ] + }, + "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" + ] + }, + "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" + ] + }, + "release": { + "title": "Release", + "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "type": "object", + "required": [ + "assets", + "assets_url", + "author", + "body", + "created_at", + "draft", + "html_url", + "id", + "name", + "node_id", + "prerelease", + "immutable", + "published_at", + "tag_name", + "tarball_url", + "target_commitish", + "updated_at", + "upload_url", + "url", + "zipball_url" + ], + "properties": { + "assets": { + "type": "array", + "items": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": [ + "object", + "null" + ], + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], + "properties": { + "browser_download_url": { + "type": "string", + "format": "uri" + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "download_count": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "label": { + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": [ + "string", + "null" + ] + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "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" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "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" + } + } + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Whether the release is a draft or published", + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "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" + } + } + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string" + }, + "tarball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + } + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "release", + "repository" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-advisory-published": { + "post": { + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_advisory", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Repository advisory published event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" ] }, "enterprise": { @@ -1588382,6 +1594111,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1591703,6 +1597475,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1595024,6 +1600839,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1596114,57 +1601972,31 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", "type": "object", "properties": { "id": { "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." + "description": "ID of the actor that can dismiss reviews." }, "type": { "type": "string", - "description": "The type of the reviewer", + "description": "The type of the actor", "enum": [ - "Team" + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" ] } }, @@ -1596174,864 +1602006,976 @@ ] } }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } - }, - { - "title": "license_compliance_scanning", - "description": "Enforce any added or changed dependencies to comply with the organization's license policy.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "license_compliance_scanning" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - } - ] - } - }, - "deleted": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, + { + "title": "license_compliance_scanning", + "description": "Enforce any added or changed dependencies to comply with the organization's license policy.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "license_compliance_scanning" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + } + ] + } + }, + "deleted": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" ] }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1597953,6 +1603897,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1598932,206 +1604919,4346 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "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" + ] + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "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" + ] + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-vulnerability-alert-create": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_vulnerability_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { - "type": "object", + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "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" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "auto_dismissed", + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1601011,7 +1611138,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1601027,23 +1611154,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1601065,7 +1611190,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -1601108,15 +1611233,199 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": [ + "string", + "null" + ] + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "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" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1602995,6 +1613304,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1603010,21 +1613320,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1603091,13 +1613399,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1605175,11 +1615483,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1605246,13 +1615554,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1605263,9 +1615571,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1605285,12 +1615590,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": [ - "string", - "null" - ] - }, "dismiss_reason": { "type": "string" }, @@ -1605390,9 +1615689,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1605434,7 +1615730,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1607341,13 +1617638,13 @@ } } }, - "repository-vulnerability-alert-reopen": { + "secret-scanning-alert-assigned": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1607369,7 +1617666,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1607412,187 +1617709,1252 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert reopen event", + "title": "secret_scanning_alert assigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopen" + "assigned" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "email": { - "type": [ - "string", - "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" ] + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" + { + "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" + ] + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" }, - "subscriptions_url": { - "type": "string", - "format": "uri" + { + "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" + ] + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "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" ] + } + ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "anyOf": [ + { + "type": "null" }, - "url": { - "type": "string", - "format": "uri" + { + "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" + ] } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] } + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "external_identifier": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "external_reference": { + "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" ], - "format": "uri" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "fix_reason": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "fixed_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "fixed_in": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "ghsa_id": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "id": { - "type": "integer" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "number": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "severity": { - "type": "string" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "state": { + "repos_url": { "type": "string", - "enum": [ - "auto_dismissed", - "open" + "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" + ] }, "enterprise": { "title": "Enterprise", @@ -1609473,8 +1620835,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1609488,21 +1620849,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1609524,7 +1620886,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1609567,185 +1620929,1082 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "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" ] - }, - "url": { - "type": "string", - "format": "uri" } - } + ] }, - "external_identifier": { - "type": "string" + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." }, - "external_reference": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { "type": [ "string", "null" ], - "format": "uri" + "description": "The provider of the secret that was detected." }, - "fix_reason": { - "type": "string" + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." }, - "fixed_at": { + "validity": { "type": "string", - "format": "date-time" + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "fixed_in": { - "type": "string" + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." }, - "ghsa_id": { - "type": "string" + "push_protection_bypassed_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" + ] + } + ] }, - "id": { - "type": "integer" + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, - "node_id": { - "type": "string" + "push_protection_bypass_request_reviewer": { + "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" + ] + } + ] }, - "number": { - "type": "integer" + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "severity": { - "type": "string" + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "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" + ] + } ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1611628,8 +1623887,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1611643,21 +1623901,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-assigned": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was assigned.", - "operationId": "secret-scanning-alert/assigned", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1611679,7 +1623938,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "secret_scanning_alert_location", "schema": { "type": "string" } @@ -1611722,13 +1623981,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert assigned event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "assigned" + "created" ] }, "alert": { @@ -1612776,291 +1625035,475 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", + "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": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "The ID of the installation.", "type": "integer", - "format": "int64", "examples": [ 1 ] }, "node_id": { + "description": "The global node ID of the installation.", "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" + "MDQ6VXNlcjU4MzIzMQ==" ] } }, "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" + "node_id" ] }, - "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).\"", + "location": { "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": { "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" ], - "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", + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", "examples": [ - 1 + "commit" ] }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "examples": [ + "/example/secrets.txt" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": [ + "/example/Home.md" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082" + ] + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussion-4566270" + ] + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + ] + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } ] } - }, - "required": [ - "id", - "node_id" - ] + } }, "organization": { "title": "Organization Simple", @@ -1614824,10 +1627267,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1614839,8 +1627457,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1614849,11 +1627468,11 @@ } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-metadata-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "description": "Metadata was created for a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1614920,13 +1627539,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "secret_scanning_alert metadata created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_created" ] }, "alert": { @@ -1615575,405 +1628194,427 @@ } ] }, - "push_protection_bypass_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when reviewing a push protection bypass." - }, - "push_protection_bypass_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when requesting a push protection bypass." - }, - "push_protection_bypass_request_html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was publicly leaked." - }, - "multi_repo": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or business." - }, - "assigned_to": { - "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" - ] - } + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "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" + ] + } + ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." }, - "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" - ] - } - ] - }, - "closure_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request author." - }, - "closure_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request reviewer." - }, - "closure_request_reviewer": { - "anyOf": [ - { - "type": "null" + "value": { + "type": "string", + "description": "The metadata value." + } }, - { - "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": [ + "key", + "value" + ] + } } } }, @@ -1617868,7 +1630509,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -1617879,13 +1630519,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-metadata-removed": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "Metadata was removed from a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1617907,7 +1630547,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert_location", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1617950,13 +1630590,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert metadata removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_removed" ] }, "alert": { @@ -1619004,453 +1631644,145 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, - "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).\"", + "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": "The ID of the installation.", + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { - "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "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" + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, - "location": { + "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": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "commit" + 1 ] }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/example/secrets.txt" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL to get the associated commit resource.", - "examples": [ - "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "examples": [ - "/example/Home.md" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1" - ] - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1" - ] - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" - ] - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082" - ] - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussion-4566270" - ] - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846" - ] - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846" - ] - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" - ] - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request review where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" - ] - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request review comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" ] } - } + }, + "required": [ + "id", + "node_id" + ] }, "organization": { "title": "Organization Simple", @@ -1621214,185 +1633546,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1621403,10 +1633560,8 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1622540,6 +1634695,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1625382,194 +1637559,216 @@ } ] }, - "closure_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request author." - }, - "closure_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request reviewer." - }, - "closure_request_reviewer": { - "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" - ] - } + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." }, - "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" - ] - } - ] + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1628600,6 +1640799,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1631630,6 +1643851,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1634828,6 +1647071,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index 044537eed3..48095b660f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -1048,7 +1048,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &668 + - &670 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -14449,7 +14449,7 @@ paths: properties: action: type: string - discussion: &761 + discussion: &763 title: Discussion description: A Discussion in a repository. type: object @@ -15236,7 +15236,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &679 + sub_issues_summary: &681 title: Sub-issues Summary type: object properties: @@ -15366,7 +15366,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &680 + issue_dependencies_summary: &682 title: Issue Dependencies Summary type: object properties: @@ -22667,7 +22667,7 @@ paths: parameters: - *74 - *116 - - &739 + - &741 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -22779,7 +22779,7 @@ paths: - *116 - *117 - *118 - - &740 + - &742 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -22787,7 +22787,7 @@ paths: schema: type: string - *121 - - &741 + - &743 name: sku description: The SKU to query for usage. in: query @@ -30461,12 +30461,12 @@ paths: required: - subject_digests examples: - default: &720 + default: &722 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &721 + withPredicateType: &723 value: subject_digests: - sha256:abc123 @@ -30511,7 +30511,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &722 + default: &724 value: attestations_subject_digests: - sha256:abc: @@ -42712,7 +42712,7 @@ paths: parameters: - *74 - *257 - - &702 + - &704 name: repo_name description: repo_name parameter in: path @@ -43660,7 +43660,7 @@ paths: - nuget - container - *74 - - &703 + - &705 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -43701,7 +43701,7 @@ paths: default: *263 '403': *27 '401': *23 - '400': &705 + '400': &707 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -45943,7 +45943,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &789 + - &791 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -46829,7 +46829,7 @@ paths: - updated_at - project_url examples: - default: &726 + default: &728 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47006,7 +47006,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &727 + items: &729 type: object properties: name: @@ -47043,7 +47043,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &728 + iteration_configuration: &730 type: object description: The configuration for iteration fields. properties: @@ -47093,7 +47093,7 @@ paths: value: name: Due date data_type: date - single_select_field: &729 + single_select_field: &731 summary: Create a single select field value: name: Priority @@ -47120,7 +47120,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &730 + iteration_field: &732 summary: Create an iteration field value: name: Sprint @@ -47146,7 +47146,7 @@ paths: application/json: schema: *283 examples: - text_field: &731 + text_field: &733 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -47155,7 +47155,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &732 + number_field: &734 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -47164,7 +47164,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &733 + date_field: &735 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -47173,7 +47173,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &734 + single_select_field: &736 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47207,7 +47207,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &735 + iteration_field: &737 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -47253,7 +47253,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *280 - - &736 + - &738 name: field_id description: The unique identifier of the field. in: path @@ -47268,7 +47268,7 @@ paths: application/json: schema: *283 examples: - default: &737 + default: &739 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -48479,7 +48479,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &717 + schema: &719 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -48662,7 +48662,7 @@ paths: parameters: - *280 - *74 - - &738 + - &740 name: view_number description: The number that identifies the project view. in: path @@ -51224,6 +51224,43 @@ paths: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + title: DismissalRestriction + description: Specify people, teams, or apps allowed + to dismiss pull request reviews. + type: object + properties: + allowed_actors: + type: array + description: Specify people, teams, or apps + allowed to dismiss pull request reviews. + items: + title: Actor + description: An actor allowed to dismiss pull + request reviews + type: object + properties: + id: + type: integer + description: ID of the actor that can + dismiss reviews. + type: + type: string + description: The type of the actor + enum: + - User + - Team + - IntegrationInstallation + - RepositoryRole + required: + - id + - type + enabled: + type: boolean + description: Whether to restrict review dismissal + to specific actors. + required: + - enabled require_code_owner_review: type: boolean description: Require an approving review in pull @@ -52826,6 +52863,29 @@ paths: required: false schema: type: boolean + - &646 + name: included_metadata + in: query + description: |- + A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the + specified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`, + `owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`, + `organization-id`, `last-used-date`, and `has-organization-access`. + required: false + schema: + type: string + - &647 + name: owner_email_hash + in: query + description: |- + Filters alerts to only those whose attached `owner_email` metadata field matches the + provided value. The value must be the lowercase hex-encoded SHA-256 hash of the email + address to match (for example, the SHA-256 of `user@example.com`). Only alerts that + have an `owner_email` metadata value whose SHA-256 hash equals this parameter are + returned. + required: false + schema: + type: string responses: '200': description: Response @@ -52849,14 +52909,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &646 + state: &648 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &647 + resolution: &649 type: - string - 'null' @@ -52975,14 +53035,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &648 + - &650 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &650 + - &652 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -53046,7 +53106,7 @@ paths: - blob_url - commit_sha - commit_url - - &651 + - &653 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -53107,7 +53167,7 @@ paths: - page_url - commit_sha - commit_url - - &652 + - &654 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -53129,7 +53189,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &653 + - &655 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -53151,7 +53211,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &654 + - &656 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -53173,7 +53233,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &655 + - &657 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -53188,7 +53248,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &656 + - &658 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -53203,7 +53263,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &657 + - &659 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -53218,7 +53278,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &658 + - &660 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -53240,7 +53300,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &659 + - &661 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -53262,7 +53322,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &660 + - &662 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -53284,7 +53344,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &661 + - &663 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -53306,7 +53366,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &662 + - &664 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -53827,7 +53887,7 @@ paths: application/json: schema: type: array - items: &666 + items: &668 description: A repository security advisory. type: object properties: @@ -54124,7 +54184,7 @@ paths: - private_fork additionalProperties: false examples: - default: &667 + default: &669 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -56056,7 +56116,7 @@ paths: application/json: schema: type: array - items: &682 + items: &684 title: Team Member description: A user that is a member of a team, including their role on the team and whether the membership is inherited from @@ -56199,7 +56259,7 @@ paths: - type - url examples: - default: &683 + default: &685 value: - login: octocat id: 1 @@ -56286,7 +56346,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &684 + response-if-user-is-a-team-maintainer: &686 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -56351,7 +56411,7 @@ paths: application/json: schema: *336 examples: - response-if-users-membership-with-team-is-now-pending: &685 + response-if-users-membership-with-team-is-now-pending: &687 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -56465,7 +56525,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &686 + schema: &688 title: Team Repository description: A team's access to a repository. type: object @@ -57186,7 +57246,7 @@ paths: type: array items: *200 examples: - response-if-child-teams-exist: &687 + response-if-child-teams-exist: &689 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -69265,7 +69325,7 @@ paths: check. type: array items: *85 - deployment: &750 + deployment: &752 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -74983,7 +75043,7 @@ paths: type: array items: *459 examples: - default: &692 + default: &694 value: total_count: 2 machines: @@ -78160,7 +78220,7 @@ paths: application/json: schema: type: array - items: &671 + items: &673 title: Status description: The status of a commit. type: object @@ -79786,7 +79846,7 @@ paths: items: type: object properties: - placeholder_id: &663 + placeholder_id: &665 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -85991,7 +86051,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &781 + last_response: &783 title: Hook Response type: object properties: @@ -87060,7 +87120,7 @@ paths: parameters: - *337 - *338 - - &715 + - &717 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -87645,7 +87705,7 @@ paths: type: array items: *534 examples: - default: &707 + default: &709 value: - id: 1 repository: @@ -102598,6 +102658,8 @@ paths: - *643 - *644 - *645 + - *646 + - *647 responses: '200': description: Response @@ -102605,7 +102667,7 @@ paths: application/json: schema: type: array - items: &649 + items: type: object properties: number: *180 @@ -102621,8 +102683,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *646 - resolution: *647 + state: *648 + resolution: *649 resolved_at: type: - string @@ -102728,7 +102790,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *648 + - *650 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -102896,7 +102958,168 @@ paths: description: Response content: application/json: - schema: *649 + schema: &651 + type: object + properties: + number: *180 + created_at: *181 + updated_at: + anyOf: + - type: 'null' + - *182 + url: *183 + html_url: *184 + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: *648 + resolution: *649 + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - *4 + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + provider: + type: + - string + - 'null' + description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret + that was detected. Use this value for filtering by provider + with the `providers` or `exclude_providers` parameters. + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected + secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - *4 + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO + 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection + bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the detected secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple + repositories under the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert + is base64 encoded + first_location_detected: + anyOf: + - type: 'null' + - *650 + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token + in the alert was detected in more than one location. + assigned_to: + anyOf: + - type: 'null' + - *4 + closure_request_comment: + type: + - string + - 'null' + description: An optional comment from the closure request author. + closure_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment from the closure request reviewer. + closure_request_reviewer: + anyOf: + - type: 'null' + - *4 + metadata: &802 + type: array + description: A list of metadata key/value pairs associated with + the secret scanning alert. + readOnly: true + items: + type: object + properties: + key: + type: string + description: The metadata key. + value: + type: string + description: The metadata value. + required: + - key + - value examples: default: value: @@ -102923,6 +103146,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com '304': *35 '404': description: Repository is public, or secret scanning is disabled for the @@ -102960,8 +103186,8 @@ paths: schema: type: object properties: - state: *646 - resolution: *647 + state: *648 + resolution: *649 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -103009,7 +103235,7 @@ paths: description: Response content: application/json: - schema: *649 + schema: *651 examples: default: value: @@ -103054,6 +103280,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -103121,7 +103350,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &801 + items: &804 type: object properties: type: @@ -103148,8 +103377,6 @@ paths: - commit details: oneOf: - - *650 - - *651 - *652 - *653 - *654 @@ -103161,6 +103388,8 @@ paths: - *660 - *661 - *662 + - *663 + - *664 examples: default: value: @@ -103255,14 +103484,14 @@ paths: schema: type: object properties: - reason: &664 + reason: &666 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *663 + placeholder_id: *665 required: - reason - placeholder_id @@ -103279,7 +103508,7 @@ paths: schema: type: object properties: - reason: *664 + reason: *666 expire_at: type: - string @@ -103342,7 +103571,7 @@ paths: properties: incremental_scans: type: array - items: &665 + items: &667 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103375,15 +103604,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *665 + items: *667 backfill_scans: type: array - items: *665 + items: *667 custom_pattern_backfill_scans: type: array items: allOf: - - *665 + - *667 - type: object properties: pattern_name: @@ -103396,7 +103625,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *665 + items: *667 examples: default: value: @@ -103506,9 +103735,9 @@ paths: application/json: schema: type: array - items: *666 + items: *668 examples: - default: *667 + default: *669 '400': *14 '404': *6 x-github: @@ -103702,9 +103931,9 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: &669 + default: &671 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -104048,7 +104277,7 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: default: value: @@ -104196,15 +104425,15 @@ paths: parameters: - *337 - *338 - - *668 + - *670 responses: '200': description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: *669 + default: *671 '403': *27 '404': *6 x-github: @@ -104230,7 +104459,7 @@ paths: parameters: - *337 - *338 - - *668 + - *670 requestBody: required: true content: @@ -104401,10 +104630,10 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: *669 - add_credit: *669 + default: *671 + add_credit: *671 '403': *27 '404': *6 '422': @@ -104444,7 +104673,7 @@ paths: parameters: - *337 - *338 - - *668 + - *670 responses: '202': *37 '400': *14 @@ -104473,7 +104702,7 @@ paths: parameters: - *337 - *338 - - *668 + - *670 responses: '202': description: Response @@ -104614,7 +104843,7 @@ paths: application/json: schema: type: array - items: &670 + items: &672 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104987,7 +105216,7 @@ paths: application/json: schema: type: array - items: *670 + items: *672 examples: default: value: @@ -105077,7 +105306,7 @@ paths: description: Response content: application/json: - schema: *671 + schema: *673 examples: default: value: @@ -105171,7 +105400,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &672 + schema: &674 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -105271,7 +105500,7 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: default: value: @@ -105481,7 +105710,7 @@ paths: description: Response content: application/json: - schema: &673 + schema: &675 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105493,7 +105722,7 @@ paths: required: - names examples: - default: &674 + default: &676 value: names: - octocat @@ -105548,9 +105777,9 @@ paths: description: Response content: application/json: - schema: *673 + schema: *675 examples: - default: *674 + default: *676 '404': *6 '422': *7 x-github: @@ -105573,7 +105802,7 @@ paths: parameters: - *337 - *338 - - &675 + - &677 name: per description: The time frame to display results for. in: query @@ -105604,7 +105833,7 @@ paths: - 128 clones: type: array - items: &676 + items: &678 title: Traffic type: object properties: @@ -105852,7 +106081,7 @@ paths: parameters: - *337 - *338 - - *675 + - *677 responses: '200': description: Response @@ -105873,7 +106102,7 @@ paths: - 3782 views: type: array - items: *676 + items: *678 required: - uniques - count @@ -106645,7 +106874,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &677 + text_matches: &679 title: Search Result Text Matches type: array items: @@ -106808,7 +107037,7 @@ paths: enum: - author-date - committer-date - - &678 + - &680 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -106928,7 +107157,7 @@ paths: type: number node_id: type: string - text_matches: *677 + text_matches: *679 required: - sha - node_id @@ -107120,7 +107349,7 @@ paths: - interactions - created - updated - - *678 + - *680 - *17 - *19 - name: advanced_search @@ -107234,8 +107463,8 @@ paths: type: - string - 'null' - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -107262,7 +107491,7 @@ paths: - string - 'null' format: date-time - text_matches: *677 + text_matches: *679 pull_request: type: object properties: @@ -107536,7 +107765,7 @@ paths: enum: - created - updated - - *678 + - *680 - *17 - *19 responses: @@ -107581,7 +107810,7 @@ paths: - 'null' score: type: number - text_matches: *677 + text_matches: *679 required: - id - node_id @@ -107666,7 +107895,7 @@ paths: - forks - help-wanted-issues - updated - - *678 + - *680 - *17 - *19 responses: @@ -107912,7 +108141,7 @@ paths: - admin - pull - push - text_matches: *677 + text_matches: *679 temp_clone_token: type: string allow_merge_commit: @@ -108220,7 +108449,7 @@ paths: - string - 'null' format: uri - text_matches: *677 + text_matches: *679 related: type: - array @@ -108413,7 +108642,7 @@ paths: - followers - repositories - joined - - *678 + - *680 - *17 - *19 responses: @@ -108523,7 +108752,7 @@ paths: type: - boolean - 'null' - text_matches: *677 + text_matches: *679 blog: type: - string @@ -108605,7 +108834,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &681 + - &683 name: team_id description: The unique identifier of the team. in: path @@ -108646,7 +108875,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *681 + - *683 requestBody: required: true content: @@ -108747,7 +108976,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *681 + - *683 responses: '204': description: Response @@ -108776,7 +109005,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -108816,7 +109045,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *681 + - *683 - name: role description: Filters members returned by their role in the team. in: query @@ -108837,9 +109066,9 @@ paths: application/json: schema: type: array - items: *682 + items: *684 examples: - default: *683 + default: *685 headers: Link: *66 '404': *6 @@ -108867,7 +109096,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -108904,7 +109133,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -108944,7 +109173,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -108981,7 +109210,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *681 + - *683 - *70 responses: '200': @@ -108990,7 +109219,7 @@ paths: application/json: schema: *336 examples: - response-if-user-is-a-team-maintainer: *684 + response-if-user-is-a-team-maintainer: *686 '404': *6 x-github: githubCloudOnly: false @@ -109023,7 +109252,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *681 + - *683 - *70 requestBody: required: false @@ -109051,7 +109280,7 @@ paths: application/json: schema: *336 examples: - response-if-users-membership-with-team-is-now-pending: *685 + response-if-users-membership-with-team-is-now-pending: *687 '403': description: Forbidden if team synchronization is set up '422': @@ -109085,7 +109314,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -109113,7 +109342,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -109155,7 +109384,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *681 + - *683 - *337 - *338 responses: @@ -109163,7 +109392,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *686 + schema: *688 examples: alternative-response-with-extra-repository-information: value: @@ -109313,7 +109542,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *681 + - *683 - *337 - *338 requestBody: @@ -109365,7 +109594,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *681 + - *683 - *337 - *338 responses: @@ -109392,7 +109621,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -109404,7 +109633,7 @@ paths: type: array items: *200 examples: - response-if-child-teams-exist: *687 + response-if-child-teams-exist: *689 headers: Link: *66 '404': *6 @@ -109437,7 +109666,7 @@ paths: application/json: schema: oneOf: - - &688 + - &690 title: Private User description: Private User type: object @@ -109687,7 +109916,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &714 + - &716 title: Public User description: Public User type: object @@ -110021,7 +110250,7 @@ paths: description: Response content: application/json: - schema: *688 + schema: *690 examples: default: value: @@ -110419,7 +110648,7 @@ paths: type: integer secrets: type: array - items: &689 + items: &691 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -110539,7 +110768,7 @@ paths: description: Response content: application/json: - schema: *689 + schema: *691 examples: default: value: @@ -110952,7 +111181,7 @@ paths: description: Response content: application/json: - schema: &690 + schema: &692 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -111005,7 +111234,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &691 + default: &693 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -111050,9 +111279,9 @@ paths: description: Response content: application/json: - schema: *690 + schema: *692 examples: - default: *691 + default: *693 '404': *6 x-github: githubCloudOnly: false @@ -111091,7 +111320,7 @@ paths: type: array items: *459 examples: - default: *692 + default: *694 '304': *35 '500': *53 '401': *23 @@ -112057,7 +112286,7 @@ paths: type: array items: *262 examples: - default: &704 + default: &706 value: - id: 197 name: hello_docker @@ -112158,7 +112387,7 @@ paths: application/json: schema: type: array - items: &693 + items: &695 title: Email description: Email type: object @@ -112228,9 +112457,9 @@ paths: application/json: schema: type: array - items: *693 + items: *695 examples: - default: &706 + default: &708 value: - email: octocat@github.com verified: true @@ -112307,7 +112536,7 @@ paths: application/json: schema: type: array - items: *693 + items: *695 examples: default: value: @@ -112565,7 +112794,7 @@ paths: application/json: schema: type: array - items: &694 + items: &696 title: GPG Key description: A unique encryption key type: object @@ -112710,7 +112939,7 @@ paths: - subkeys - revoked examples: - default: &724 + default: &726 value: - id: 3 name: Octocat's GPG Key @@ -112795,9 +113024,9 @@ paths: description: Response content: application/json: - schema: *694 + schema: *696 examples: - default: &695 + default: &697 value: id: 3 name: Octocat's GPG Key @@ -112854,7 +113083,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &696 + - &698 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -112866,9 +113095,9 @@ paths: description: Response content: application/json: - schema: *694 + schema: *696 examples: - default: *695 + default: *697 '404': *6 '304': *35 '403': *27 @@ -112891,7 +113120,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *696 + - *698 responses: '204': description: Response @@ -113358,7 +113587,7 @@ paths: application/json: schema: type: array - items: &697 + items: &699 title: Key description: Key type: object @@ -113461,9 +113690,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *699 examples: - default: &698 + default: &700 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -113502,9 +113731,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *699 examples: - default: *698 + default: *700 '404': *6 '304': *35 '403': *27 @@ -113560,7 +113789,7 @@ paths: application/json: schema: type: array - items: &699 + items: &701 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -113639,7 +113868,7 @@ paths: - account - plan examples: - default: &700 + default: &702 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -113701,9 +113930,9 @@ paths: application/json: schema: type: array - items: *699 + items: *701 examples: - default: *700 + default: *702 headers: Link: *66 '304': *35 @@ -113946,7 +114175,7 @@ paths: application/json: schema: *254 examples: - default: &701 + default: &703 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -113995,7 +114224,7 @@ paths: application/json: schema: *254 examples: - default: *701 + default: *703 '403': *27 '404': *6 '422': *15 @@ -114729,7 +114958,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *257 - - *702 + - *704 responses: '204': description: Response @@ -114842,7 +115071,7 @@ paths: - docker - nuget - container - - *703 + - *705 - *19 - *17 responses: @@ -114854,8 +115083,8 @@ paths: type: array items: *262 examples: - default: *704 - '400': *705 + default: *706 + '400': *707 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -114884,7 +115113,7 @@ paths: application/json: schema: *262 examples: - default: &725 + default: &727 value: id: 40201 name: octo-name @@ -115246,9 +115475,9 @@ paths: application/json: schema: type: array - items: *693 + items: *695 examples: - default: *706 + default: *708 headers: Link: *66 '304': *35 @@ -115361,7 +115590,7 @@ paths: type: array items: *78 examples: - default: &713 + default: &715 summary: Default response value: - id: 1296269 @@ -115722,7 +115951,7 @@ paths: type: array items: *534 examples: - default: *707 + default: *709 headers: Link: *66 '304': *35 @@ -115802,7 +116031,7 @@ paths: application/json: schema: type: array - items: &708 + items: &710 title: Social account description: Social media account type: object @@ -115819,7 +116048,7 @@ paths: - provider - url examples: - default: &709 + default: &711 value: - provider: twitter url: https://twitter.com/github @@ -115882,9 +116111,9 @@ paths: application/json: schema: type: array - items: *708 + items: *710 examples: - default: *709 + default: *711 '422': *15 '304': *35 '404': *6 @@ -115972,7 +116201,7 @@ paths: application/json: schema: type: array - items: &710 + items: &712 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -115992,7 +116221,7 @@ paths: - title - created_at examples: - default: &742 + default: &744 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -116057,9 +116286,9 @@ paths: description: Response content: application/json: - schema: *710 + schema: *712 examples: - default: &711 + default: &713 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -116089,7 +116318,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &712 + - &714 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -116101,9 +116330,9 @@ paths: description: Response content: application/json: - schema: *710 + schema: *712 examples: - default: *711 + default: *713 '404': *6 '304': *35 '403': *27 @@ -116126,7 +116355,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *712 + - *714 responses: '204': description: Response @@ -116155,7 +116384,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &743 + - &745 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -116180,11 +116409,11 @@ paths: type: array items: *78 examples: - default-response: *713 + default-response: *715 application/vnd.github.v3.star+json: schema: type: array - items: &744 + items: &746 title: Starred Repository description: Starred Repository type: object @@ -116553,10 +116782,10 @@ paths: application/json: schema: oneOf: - - *688 - - *714 + - *690 + - *716 examples: - default-response: &718 + default-response: &720 summary: Default response value: login: octocat @@ -116591,7 +116820,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &719 + response-with-git-hub-plan-information: &721 summary: Response with GitHub plan information value: login: octocat @@ -116648,7 +116877,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &716 + - &718 name: user_id description: The unique identifier of the user. in: path @@ -116714,7 +116943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *715 + - *717 - *17 responses: '200': @@ -116749,7 +116978,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *716 + - *718 - *280 requestBody: required: true @@ -116824,7 +117053,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *717 + schema: *719 examples: table_view: summary: Response for creating a table view @@ -116876,11 +117105,11 @@ paths: application/json: schema: oneOf: - - *688 - - *714 + - *690 + - *716 examples: - default-response: *718 - response-with-git-hub-plan-information: *719 + default-response: *720 + response-with-git-hub-plan-information: *721 '404': *6 x-github: githubCloudOnly: false @@ -116930,8 +117159,8 @@ paths: required: - subject_digests examples: - default: *720 - withPredicateType: *721 + default: *722 + withPredicateType: *723 responses: '200': description: Response @@ -116971,7 +117200,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *722 + default: *724 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -117444,7 +117673,7 @@ paths: application/json: schema: *196 examples: - default: &723 + default: &725 summary: Example response for a user copilot space value: id: 42 @@ -117545,7 +117774,7 @@ paths: application/json: schema: *196 examples: - default: *723 + default: *725 '403': *27 '404': *6 x-github: @@ -117671,7 +117900,7 @@ paths: application/json: schema: *196 examples: - default: *723 + default: *725 '403': *27 '404': *6 '422': *15 @@ -118439,7 +118668,7 @@ paths: type: array items: *262 examples: - default: *704 + default: *706 '403': *27 '401': *23 x-github: @@ -118823,9 +119052,9 @@ paths: application/json: schema: type: array - items: *694 + items: *696 examples: - default: *724 + default: *726 headers: Link: *66 x-github: @@ -119054,7 +119283,7 @@ paths: - docker - nuget - container - - *703 + - *705 - *70 - *19 - *17 @@ -119067,10 +119296,10 @@ paths: type: array items: *262 examples: - default: *704 + default: *706 '403': *27 '401': *23 - '400': *705 + '400': *707 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119100,7 +119329,7 @@ paths: application/json: schema: *262 examples: - default: *725 + default: *727 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119449,7 +119678,7 @@ paths: type: array items: *283 examples: - default: *726 + default: *728 headers: Link: *66 '304': *35 @@ -119509,7 +119738,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *727 + items: *729 required: - name - data_type @@ -119525,7 +119754,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *728 + iteration_configuration: *730 required: - name - data_type @@ -119547,8 +119776,8 @@ paths: value: name: Due date data_type: date - single_select_field: *729 - iteration_field: *730 + single_select_field: *731 + iteration_field: *732 responses: '201': description: Response @@ -119556,11 +119785,11 @@ paths: application/json: schema: *283 examples: - text_field: *731 - number_field: *732 - date_field: *733 - single_select_field: *734 - iteration_field: *735 + text_field: *733 + number_field: *734 + date_field: *735 + single_select_field: *736 + iteration_field: *737 '304': *35 '403': *27 '401': *23 @@ -119582,7 +119811,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *280 - - *736 + - *738 - *70 responses: '200': @@ -119591,7 +119820,7 @@ paths: application/json: schema: *283 examples: - default: *737 + default: *739 headers: Link: *66 '304': *35 @@ -119948,7 +120177,7 @@ paths: parameters: - *280 - *70 - - *738 + - *740 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -120487,7 +120716,7 @@ paths: parameters: - *70 - *116 - - *739 + - *741 - *118 responses: '200': @@ -120586,9 +120815,9 @@ paths: - *116 - *117 - *118 - - *740 + - *742 - *121 - - *741 + - *743 responses: '200': description: Response when getting a billing usage summary @@ -120722,9 +120951,9 @@ paths: application/json: schema: type: array - items: *708 + items: *710 examples: - default: *709 + default: *711 headers: Link: *66 x-github: @@ -120754,9 +120983,9 @@ paths: application/json: schema: type: array - items: *710 + items: *712 examples: - default: *742 + default: *744 headers: Link: *66 x-github: @@ -120781,7 +121010,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *70 - - *743 + - *745 - *60 - *17 - *19 @@ -120793,11 +121022,11 @@ paths: schema: anyOf: - type: array - items: *744 + items: *746 - type: array items: *78 examples: - default-response: *713 + default-response: *715 headers: Link: *66 x-github: @@ -120957,7 +121186,7 @@ webhooks: type: string enum: - disabled - enterprise: &745 + enterprise: &747 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -121026,7 +121255,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &746 + installation: &748 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -121047,7 +121276,7 @@ webhooks: required: - id - node_id - organization: &747 + organization: &749 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -121120,7 +121349,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &748 + repository: &750 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -122035,10 +122264,10 @@ webhooks: type: string enum: - enabled - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -122114,11 +122343,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - rule: &749 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + rule: &751 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -122341,11 +122570,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - rule: *749 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + rule: *751 sender: *4 required: - action @@ -122533,11 +122762,11 @@ webhooks: - everyone required: - from - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - rule: *749 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + rule: *751 sender: *4 required: - action @@ -122621,7 +122850,7 @@ webhooks: type: string enum: - completed - check_run: &751 + check_run: &753 title: CheckRun description: A check performed on the code of a given code change type: object @@ -122731,7 +122960,7 @@ webhooks: - examples: - neutral - deployment: *750 + deployment: *752 details_url: type: string examples: @@ -122829,10 +123058,10 @@ webhooks: - output - app - pull_requests - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 sender: *4 required: - check_run @@ -123223,11 +123452,11 @@ webhooks: type: string enum: - created - check_run: *751 - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + check_run: *753 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 sender: *4 required: - check_run @@ -123621,11 +123850,11 @@ webhooks: type: string enum: - requested_action - check_run: *751 - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + check_run: *753 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 requested_action: description: The action requested by the user. type: object @@ -124028,11 +124257,11 @@ webhooks: type: string enum: - rerequested - check_run: *751 - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + check_run: *753 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 sender: *4 required: - check_run @@ -125017,10 +125246,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -125734,10 +125963,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -126445,10 +126674,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -126769,20 +126998,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &752 + commit_oid: &754 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *745 - installation: *746 - organization: *747 - ref: &753 + enterprise: *747 + installation: *748 + organization: *749 + ref: &755 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *748 + repository: *750 sender: *4 required: - action @@ -127190,12 +127419,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -127478,12 +127707,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -127829,12 +128058,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -128124,9 +128353,9 @@ webhooks: type: - string - 'null' - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -128134,7 +128363,7 @@ webhooks: type: - string - 'null' - repository: *748 + repository: *750 sender: *4 required: - action @@ -128380,12 +128609,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -128706,10 +128935,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -128969,10 +129198,10 @@ webhooks: - updated_at - author_association - body - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -129053,18 +129282,18 @@ webhooks: type: - string - 'null' - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *747 - pusher_type: &754 + organization: *749 + pusher_type: &756 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &755 + ref: &757 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -129074,7 +129303,7 @@ webhooks: enum: - tag - branch - repository: *748 + repository: *750 sender: *4 required: - ref @@ -129157,9 +129386,9 @@ webhooks: enum: - created definition: *291 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -129244,9 +129473,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -129324,9 +129553,9 @@ webhooks: enum: - promote_to_enterprise definition: *291 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -129404,9 +129633,9 @@ webhooks: enum: - updated definition: *291 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -129483,10 +129712,10 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - repository: *748 - organization: *747 + enterprise: *747 + installation: *748 + repository: *750 + organization: *749 sender: *4 new_property_values: type: array @@ -129571,18 +129800,18 @@ webhooks: title: delete event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - pusher_type: *754 - ref: *755 + enterprise: *747 + installation: *748 + organization: *749 + pusher_type: *756 + ref: *757 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *748 + repository: *750 sender: *4 required: - ref @@ -129663,10 +129892,10 @@ webhooks: enum: - assignees_changed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -129747,10 +129976,10 @@ webhooks: enum: - auto_dismissed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -129832,10 +130061,10 @@ webhooks: enum: - auto_reopened alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -129917,10 +130146,10 @@ webhooks: enum: - created alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130000,10 +130229,10 @@ webhooks: enum: - dismissed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130083,10 +130312,10 @@ webhooks: enum: - fixed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130167,10 +130396,10 @@ webhooks: enum: - reintroduced alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130250,10 +130479,10 @@ webhooks: enum: - reopened alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -130330,9 +130559,9 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - key: &756 + enterprise: *747 + installation: *748 + key: &758 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -130370,8 +130599,8 @@ webhooks: - verified - created_at - read_only - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -130448,11 +130677,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - key: *756 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + key: *758 + organization: *749 + repository: *750 sender: *4 required: - action @@ -131019,12 +131248,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: &760 + workflow: &762 title: Workflow type: - object @@ -131779,9 +132008,9 @@ webhooks: pull_requests: type: array items: *596 - repository: *748 - organization: *747 - installation: *746 + repository: *750 + organization: *749 + installation: *748 sender: *4 responses: '200': @@ -131852,7 +132081,7 @@ webhooks: type: string enum: - approved - approver: &757 + approver: &759 type: object properties: avatar_url: @@ -131895,11 +132124,11 @@ webhooks: type: string comment: type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - reviewers: &758 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + reviewers: &760 type: array items: type: object @@ -131980,7 +132209,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &759 + workflow_job_run: &761 type: object properties: conclusion: @@ -132726,18 +132955,18 @@ webhooks: type: string enum: - rejected - approver: *757 + approver: *759 comment: type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - reviewers: *758 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + reviewers: *760 sender: *4 since: type: string - workflow_job_run: *759 + workflow_job_run: *761 workflow_job_runs: type: array items: @@ -133454,13 +133683,13 @@ webhooks: type: string enum: - requested - enterprise: *745 + enterprise: *747 environment: type: string - installation: *746 - organization: *747 - repository: *748 - requestor: &765 + installation: *748 + organization: *749 + repository: *750 + requestor: &767 title: User type: - object @@ -135393,12 +135622,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Deployment Workflow Run type: @@ -136089,7 +136318,7 @@ webhooks: type: string enum: - answered - answer: &763 + answer: &765 type: object properties: author_association: @@ -136249,11 +136478,11 @@ webhooks: - created_at - updated_at - body - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -136380,11 +136609,11 @@ webhooks: - from required: - category - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -136467,11 +136696,11 @@ webhooks: type: string enum: - closed - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -136553,7 +136782,7 @@ webhooks: type: string enum: - created - comment: &762 + comment: &764 type: object properties: author_association: @@ -136713,11 +136942,11 @@ webhooks: - updated_at - body - reactions - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -136800,12 +137029,12 @@ webhooks: type: string enum: - deleted - comment: *762 - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + comment: *764 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -136900,12 +137129,12 @@ webhooks: - from required: - body - comment: *762 - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + comment: *764 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -136989,11 +137218,11 @@ webhooks: type: string enum: - created - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137075,11 +137304,11 @@ webhooks: type: string enum: - deleted - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137179,11 +137408,11 @@ webhooks: type: string required: - from - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137265,10 +137494,10 @@ webhooks: type: string enum: - labeled - discussion: *761 - enterprise: *745 - installation: *746 - label: &764 + discussion: *763 + enterprise: *747 + installation: *748 + label: &766 title: Label type: object properties: @@ -137301,8 +137530,8 @@ webhooks: - color - default - description - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137385,11 +137614,11 @@ webhooks: type: string enum: - locked - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137471,11 +137700,11 @@ webhooks: type: string enum: - pinned - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137557,11 +137786,11 @@ webhooks: type: string enum: - reopened - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137646,16 +137875,16 @@ webhooks: changes: type: object properties: - new_discussion: *761 - new_repository: *748 + new_discussion: *763 + new_repository: *750 required: - new_discussion - new_repository - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137738,10 +137967,10 @@ webhooks: type: string enum: - unanswered - discussion: *761 - old_answer: *763 - organization: *747 - repository: *748 + discussion: *763 + old_answer: *765 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137823,12 +138052,12 @@ webhooks: type: string enum: - unlabeled - discussion: *761 - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137911,11 +138140,11 @@ webhooks: type: string enum: - unlocked - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137997,11 +138226,11 @@ webhooks: type: string enum: - unpinned - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138074,7 +138303,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *745 + enterprise: *747 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -138752,9 +138981,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - forkee @@ -138900,9 +139129,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pages: description: The pages that were updated. type: array @@ -138940,7 +139169,7 @@ webhooks: - action - sha - html_url - repository: *748 + repository: *750 sender: *4 required: - pages @@ -139016,10 +139245,10 @@ webhooks: type: string enum: - created - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: &766 + organization: *749 + repositories: &768 description: An array of repository objects that the installation can access. type: array @@ -139045,8 +139274,8 @@ webhooks: - name - full_name - private - repository: *748 - requester: *765 + repository: *750 + requester: *767 sender: *4 required: - action @@ -139121,11 +139350,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -139202,11 +139431,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -139283,10 +139512,10 @@ webhooks: type: string enum: - added - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories_added: &767 + organization: *749 + repositories_added: &769 description: An array of repository objects, which were added to the installation. type: array @@ -139332,15 +139561,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *748 - repository_selection: &768 + repository: *750 + repository_selection: &770 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *765 + requester: *767 sender: *4 required: - action @@ -139419,10 +139648,10 @@ webhooks: type: string enum: - removed - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories_added: *767 + organization: *749 + repositories_added: *769 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -139449,9 +139678,9 @@ webhooks: - name - full_name - private - repository: *748 - repository_selection: *768 - requester: *765 + repository: *750 + repository_selection: *770 + requester: *767 sender: *4 required: - action @@ -139530,11 +139759,11 @@ webhooks: type: string enum: - suspend - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -139716,10 +139945,10 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 target_type: type: string @@ -139798,11 +140027,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -140058,8 +140287,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -140871,8 +141100,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141233,8 +141462,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -141314,7 +141543,7 @@ webhooks: type: string enum: - deleted - comment: &769 + comment: &771 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -141489,8 +141718,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -142298,8 +142527,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142662,8 +142891,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -142743,7 +142972,7 @@ webhooks: type: string enum: - edited - changes: &793 + changes: &795 description: The changes to the comment. type: object properties: @@ -142755,9 +142984,9 @@ webhooks: type: string required: - from - comment: *769 - enterprise: *745 - installation: *746 + comment: *771 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -143568,8 +143797,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143930,8 +144159,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -144012,9 +144241,9 @@ webhooks: type: string enum: - pinned - comment: *769 - enterprise: *745 - installation: *746 + comment: *771 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -144827,8 +145056,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145191,8 +145420,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -145272,9 +145501,9 @@ webhooks: type: string enum: - unpinned - comment: *769 - enterprise: *745 - installation: *746 + comment: *771 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -146087,8 +146316,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146451,8 +146680,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -146541,9 +146770,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -146632,9 +146861,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -146722,9 +146951,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -146813,9 +147042,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -146895,10 +147124,10 @@ webhooks: type: string enum: - assigned - assignee: *765 - enterprise: *745 - installation: *746 - issue: &770 + assignee: *767 + enterprise: *747 + installation: *748 + issue: &772 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -147709,8 +147938,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -147833,8 +148062,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -147914,8 +148143,8 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -148731,8 +148960,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -148998,8 +149227,8 @@ webhooks: required: - state - closed_at - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -149078,8 +149307,8 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149886,8 +150115,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -150009,8 +150238,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -150089,8 +150318,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150920,8 +151149,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -151022,7 +151251,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &771 + milestone: &773 title: Milestone description: A collection of related issues and pull requests. type: object @@ -151165,8 +151394,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -151265,8 +151494,8 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152077,8 +152306,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -152201,9 +152430,9 @@ webhooks: - active_lock_reason - body - reactions - label: *764 - organization: *747 - repository: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -152283,9 +152512,9 @@ webhooks: type: string enum: - field_added - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 issue_field: type: object description: The issue field whose value was set or updated on the @@ -152451,8 +152680,8 @@ webhooks: - id required: - from - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -152532,9 +152761,9 @@ webhooks: type: string enum: - field_removed - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -152621,8 +152850,8 @@ webhooks: - 'null' required: - id - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -152702,8 +152931,8 @@ webhooks: type: string enum: - labeled - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153513,8 +153742,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -153637,9 +153866,9 @@ webhooks: - active_lock_reason - body - reactions - label: *764 - organization: *747 - repository: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -153719,8 +153948,8 @@ webhooks: type: string enum: - locked - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -154555,8 +154784,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -154656,8 +154885,8 @@ webhooks: format: uri user_view_type: type: string - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -154736,8 +154965,8 @@ webhooks: type: string enum: - milestoned - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -155566,8 +155795,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -155667,9 +155896,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *771 - organization: *747 - repository: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -156556,8 +156785,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -157152,8 +157381,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -157960,8 +158189,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -158087,8 +158316,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -158168,9 +158397,9 @@ webhooks: type: string enum: - pinned - enterprise: *745 - installation: *746 - issue: &772 + enterprise: *747 + installation: *748 + issue: &774 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -158975,8 +159204,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -159098,8 +159327,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -159178,8 +159407,8 @@ webhooks: type: string enum: - reopened - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -160012,8 +160241,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -160114,8 +160343,8 @@ webhooks: user_view_type: type: string type: *245 - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -161003,8 +161232,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -161617,11 +161846,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *745 - installation: *746 - issue: *772 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *774 + organization: *749 + repository: *750 sender: *4 required: - action @@ -161701,12 +161930,12 @@ webhooks: type: string enum: - typed - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 type: *245 - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -161787,7 +162016,7 @@ webhooks: type: string enum: - unassigned - assignee: &796 + assignee: &798 title: User type: - object @@ -161859,11 +162088,11 @@ webhooks: required: - login - id - enterprise: *745 - installation: *746 - issue: *770 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *772 + organization: *749 + repository: *750 sender: *4 required: - action @@ -161942,12 +162171,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *745 - installation: *746 - issue: *770 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *772 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -162027,8 +162256,8 @@ webhooks: type: string enum: - unlocked - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -162861,8 +163090,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -162962,8 +163191,8 @@ webhooks: format: uri user_view_type: type: string - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163043,11 +163272,11 @@ webhooks: type: string enum: - unpinned - enterprise: *745 - installation: *746 - issue: *772 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *774 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163126,12 +163355,12 @@ webhooks: type: string enum: - untyped - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 type: *245 - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163211,11 +163440,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163293,11 +163522,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163407,11 +163636,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163493,9 +163722,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: &773 + enterprise: *747 + installation: *748 + marketplace_purchase: &775 title: Marketplace Purchase type: object required: @@ -163583,8 +163812,8 @@ webhooks: type: integer unit_count: type: integer - organization: *747 - previous_marketplace_purchase: &774 + organization: *749 + previous_marketplace_purchase: &776 title: Marketplace Purchase type: object properties: @@ -163668,7 +163897,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *748 + repository: *750 sender: *4 required: - action @@ -163748,10 +163977,10 @@ webhooks: - changed effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: *773 - organization: *747 + enterprise: *747 + installation: *748 + marketplace_purchase: *775 + organization: *749 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -163839,7 +164068,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *748 + repository: *750 sender: *4 required: - action @@ -163921,10 +164150,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: *773 - organization: *747 + enterprise: *747 + installation: *748 + marketplace_purchase: *775 + organization: *749 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -164010,7 +164239,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *748 + repository: *750 sender: *4 required: - action @@ -164091,8 +164320,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 marketplace_purchase: title: Marketplace Purchase type: object @@ -164178,9 +164407,9 @@ webhooks: type: integer unit_count: type: integer - organization: *747 - previous_marketplace_purchase: *774 - repository: *748 + organization: *749 + previous_marketplace_purchase: *776 + repository: *750 sender: *4 required: - action @@ -164260,12 +164489,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: *773 - organization: *747 - previous_marketplace_purchase: *774 - repository: *748 + enterprise: *747 + installation: *748 + marketplace_purchase: *775 + organization: *749 + previous_marketplace_purchase: *776 + repository: *750 sender: *4 required: - action @@ -164367,11 +164596,11 @@ webhooks: type: string required: - to - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 sender: *4 required: - action @@ -164473,11 +164702,11 @@ webhooks: type: - string - 'null' - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 sender: *4 required: - action @@ -164556,11 +164785,11 @@ webhooks: type: string enum: - removed - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 sender: *4 required: - action @@ -164638,11 +164867,11 @@ webhooks: type: string enum: - added - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 scope: description: The scope of the membership. Currently, can only be `team`. @@ -164720,7 +164949,7 @@ webhooks: required: - login - id - team: &775 + team: &777 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -164950,11 +165179,11 @@ webhooks: type: string enum: - removed - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 scope: description: The scope of the membership. Currently, can only be `team`. @@ -165033,7 +165262,7 @@ webhooks: required: - login - id - team: *775 + team: *777 required: - action - scope @@ -165115,8 +165344,8 @@ webhooks: type: string enum: - checks_requested - installation: *746 - merge_group: &776 + installation: *748 + merge_group: &778 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -165142,8 +165371,8 @@ webhooks: - base_sha - base_ref - head_commit - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -165229,10 +165458,10 @@ webhooks: - merged - invalidated - dequeued - installation: *746 - merge_group: *776 - organization: *747 - repository: *748 + installation: *748 + merge_group: *778 + organization: *749 + repository: *750 sender: *4 required: - action @@ -165305,7 +165534,7 @@ webhooks: type: string enum: - deleted - enterprise: *745 + enterprise: *747 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -165414,12 +165643,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *746 - organization: *747 + installation: *748 + organization: *749 repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -165499,11 +165728,11 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 - milestone: *771 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -165582,9 +165811,9 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - milestone: &777 + enterprise: *747 + installation: *748 + milestone: &779 title: Milestone description: A collection of related issues and pull requests. type: object @@ -165726,8 +165955,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -165806,11 +166035,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - milestone: *771 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -165920,11 +166149,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - milestone: *771 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166004,11 +166233,11 @@ webhooks: type: string enum: - opened - enterprise: *745 - installation: *746 - milestone: *777 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *779 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166087,11 +166316,11 @@ webhooks: type: string enum: - blocked - blocked_user: *765 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + blocked_user: *767 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166170,11 +166399,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *765 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + blocked_user: *767 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166253,9 +166482,9 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - membership: &778 + enterprise: *747 + installation: *748 + membership: &780 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -166365,8 +166594,8 @@ webhooks: - role - organization_url - user - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166444,11 +166673,11 @@ webhooks: type: string enum: - member_added - enterprise: *745 - installation: *746 - membership: *778 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + membership: *780 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166527,8 +166756,8 @@ webhooks: type: string enum: - member_invited - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -166650,10 +166879,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 - user: *765 + user: *767 required: - action - invitation @@ -166731,11 +166960,11 @@ webhooks: type: string enum: - member_removed - enterprise: *745 - installation: *746 - membership: *778 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + membership: *780 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166822,11 +167051,11 @@ webhooks: properties: from: type: string - enterprise: *745 - installation: *746 - membership: *778 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + membership: *780 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166903,9 +167132,9 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 package: description: Information about the package. type: object @@ -167428,7 +167657,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &779 + items: &781 title: Ruby Gems metadata type: object properties: @@ -167525,7 +167754,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -167601,9 +167830,9 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 package: description: Information about the package. type: object @@ -167965,7 +168194,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *779 + items: *781 source_url: type: string format: uri @@ -168036,7 +168265,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -168216,12 +168445,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *745 + enterprise: *747 id: type: integer - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - id @@ -168298,7 +168527,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &780 + personal_access_token_request: &782 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -168448,10 +168677,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *745 - organization: *747 + enterprise: *747 + organization: *749 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -168528,11 +168757,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *780 - enterprise: *745 - organization: *747 + personal_access_token_request: *782 + enterprise: *747 + organization: *749 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -168608,11 +168837,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *780 - enterprise: *745 - organization: *747 + personal_access_token_request: *782 + enterprise: *747 + organization: *749 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -168687,11 +168916,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *780 - organization: *747 - enterprise: *745 + personal_access_token_request: *782 + organization: *749 + enterprise: *747 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -168796,7 +169025,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *781 + last_response: *783 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -168828,8 +169057,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 zen: description: Random string of GitHub zen. @@ -169074,10 +169303,10 @@ webhooks: - from required: - note - enterprise: *745 - installation: *746 - organization: *747 - project_card: &782 + enterprise: *747 + installation: *748 + organization: *749 + project_card: &784 title: Project Card type: object properties: @@ -169200,7 +169429,7 @@ webhooks: - creator - created_at - updated_at - repository: *748 + repository: *750 sender: *4 required: - action @@ -169281,11 +169510,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - project_card: *782 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_card: *784 + repository: *750 sender: *4 required: - action @@ -169365,9 +169594,9 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 project_card: title: Project Card type: object @@ -169497,7 +169726,7 @@ webhooks: repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -169591,11 +169820,11 @@ webhooks: - from required: - note - enterprise: *745 - installation: *746 - organization: *747 - project_card: *782 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_card: *784 + repository: *750 sender: *4 required: - action @@ -169689,9 +169918,9 @@ webhooks: - from required: - column_id - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 project_card: allOf: - title: Project Card @@ -169888,7 +170117,7 @@ webhooks: type: string required: - after_id - repository: *748 + repository: *750 sender: *4 required: - action @@ -169968,10 +170197,10 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 - organization: *747 - project: &784 + enterprise: *747 + installation: *748 + organization: *749 + project: &786 title: Project type: object properties: @@ -170098,7 +170327,7 @@ webhooks: - creator - created_at - updated_at - repository: *748 + repository: *750 sender: *4 required: - action @@ -170178,10 +170407,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - project_column: &783 + enterprise: *747 + installation: *748 + organization: *749 + project_column: &785 title: Project Column type: object properties: @@ -170221,7 +170450,7 @@ webhooks: - name - created_at - updated_at - repository: *748 + repository: *750 sender: *4 required: - action @@ -170300,14 +170529,14 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - project_column: *783 + enterprise: *747 + installation: *748 + organization: *749 + project_column: *785 repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -170396,11 +170625,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - project_column: *783 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_column: *785 + repository: *750 sender: *4 required: - action @@ -170480,11 +170709,11 @@ webhooks: type: string enum: - moved - enterprise: *745 - installation: *746 - organization: *747 - project_column: *783 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_column: *785 + repository: *750 sender: *4 required: - action @@ -170564,11 +170793,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - project: *784 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 + repository: *750 sender: *4 required: - action @@ -170648,14 +170877,14 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - project: *784 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -170756,11 +170985,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - project: *784 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 + repository: *750 sender: *4 required: - action @@ -170839,11 +171068,11 @@ webhooks: type: string enum: - reopened - enterprise: *745 - installation: *746 - organization: *747 - project: *784 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 + repository: *750 sender: *4 required: - action @@ -170924,8 +171153,8 @@ webhooks: type: string enum: - closed - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -171007,8 +171236,8 @@ webhooks: type: string enum: - created - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -171090,8 +171319,8 @@ webhooks: type: string enum: - deleted - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -171213,8 +171442,8 @@ webhooks: type: string to: type: string - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -171298,7 +171527,7 @@ webhooks: type: string enum: - archived - changes: &788 + changes: &790 type: object properties: archived_at: @@ -171314,9 +171543,9 @@ webhooks: - string - 'null' format: date-time - installation: *746 - organization: *747 - projects_v2_item: &785 + installation: *748 + organization: *749 + projects_v2_item: &787 title: Projects v2 Item description: An item belonging to a project type: object @@ -171456,9 +171685,9 @@ webhooks: - 'null' to: type: string - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -171540,9 +171769,9 @@ webhooks: type: string enum: - created - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -171623,9 +171852,9 @@ webhooks: type: string enum: - deleted - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -171730,7 +171959,7 @@ webhooks: oneOf: - type: string - type: integer - - &786 + - &788 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -171754,7 +171983,7 @@ webhooks: required: - id - name - - &787 + - &789 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -171794,8 +172023,8 @@ webhooks: oneOf: - type: string - type: integer - - *786 - - *787 + - *788 + - *789 type: - 'null' - string @@ -171818,9 +172047,9 @@ webhooks: - 'null' required: - body - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -171917,9 +172146,9 @@ webhooks: type: - string - 'null' - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -172002,10 +172231,10 @@ webhooks: type: string enum: - restored - changes: *788 - installation: *746 - organization: *747 - projects_v2_item: *785 + changes: *790 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -172087,8 +172316,8 @@ webhooks: type: string enum: - reopened - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -172170,9 +172399,9 @@ webhooks: type: string enum: - created - installation: *746 - organization: *747 - projects_v2_status_update: *789 + installation: *748 + organization: *749 + projects_v2_status_update: *791 sender: *4 required: - action @@ -172253,9 +172482,9 @@ webhooks: type: string enum: - deleted - installation: *746 - organization: *747 - projects_v2_status_update: *789 + installation: *748 + organization: *749 + projects_v2_status_update: *791 sender: *4 required: - action @@ -172401,9 +172630,9 @@ webhooks: - string - 'null' format: date - installation: *746 - organization: *747 - projects_v2_status_update: *789 + installation: *748 + organization: *749 + projects_v2_status_update: *791 sender: *4 required: - action @@ -172474,10 +172703,10 @@ webhooks: title: public event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - repository @@ -172554,13 +172783,13 @@ webhooks: type: string enum: - assigned - assignee: *765 - enterprise: *745 - installation: *746 - number: &790 + assignee: *767 + enterprise: *747 + installation: *748 + number: &792 description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -174912,7 +175141,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -174994,11 +175223,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -177343,7 +177572,7 @@ webhooks: - draft reason: type: string - repository: *748 + repository: *750 sender: *4 required: - action @@ -177425,11 +177654,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -179774,7 +180003,7 @@ webhooks: - draft reason: type: string - repository: *748 + repository: *750 sender: *4 required: - action @@ -179856,11 +180085,11 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: &791 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: &793 allOf: - *596 - type: object @@ -179924,7 +180153,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *748 + repository: *750 sender: *4 required: - action @@ -180005,12 +180234,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -180090,11 +180319,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *745 + enterprise: *747 milestone: *281 - number: *790 - organization: *747 - pull_request: &792 + number: *792 + organization: *749 + pull_request: &794 title: Pull Request type: object properties: @@ -182438,7 +182667,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -182517,11 +182746,11 @@ webhooks: type: string enum: - dequeued - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -184884,7 +185113,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *748 + repository: *750 sender: *4 required: - action @@ -185008,12 +185237,12 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -185093,11 +185322,11 @@ webhooks: type: string enum: - enqueued - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -187445,7 +187674,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -187525,11 +187754,11 @@ webhooks: type: string enum: - labeled - enterprise: *745 - installation: *746 - label: *764 - number: *790 - organization: *747 + enterprise: *747 + installation: *748 + label: *766 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -189880,7 +190109,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -189961,10 +190190,10 @@ webhooks: type: string enum: - locked - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -192313,7 +192542,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -192393,12 +192622,12 @@ webhooks: type: string enum: - milestoned - enterprise: *745 + enterprise: *747 milestone: *281 - number: *790 - organization: *747 - pull_request: *792 - repository: *748 + number: *792 + organization: *749 + pull_request: *794 + repository: *750 sender: *4 required: - action @@ -192477,12 +192706,12 @@ webhooks: type: string enum: - opened - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -192563,12 +192792,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -192648,12 +192877,12 @@ webhooks: type: string enum: - reopened - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -193028,9 +193257,9 @@ webhooks: - start_side - side - reactions - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: type: object properties: @@ -195263,7 +195492,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *748 + repository: *750 sender: *4 required: - action @@ -195343,7 +195572,7 @@ webhooks: type: string enum: - deleted - comment: &794 + comment: &796 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -195636,9 +195865,9 @@ webhooks: - start_side - side - reactions - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: type: object properties: @@ -197859,7 +198088,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *748 + repository: *750 sender: *4 required: - action @@ -197939,11 +198168,11 @@ webhooks: type: string enum: - edited - changes: *793 - comment: *794 - enterprise: *745 - installation: *746 - organization: *747 + changes: *795 + comment: *796 + enterprise: *747 + installation: *748 + organization: *749 pull_request: type: object properties: @@ -200167,7 +200396,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *748 + repository: *750 sender: *4 required: - action @@ -200248,9 +200477,9 @@ webhooks: type: string enum: - dismissed - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -202486,7 +202715,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 + repository: *750 review: description: The review that was affected. type: object @@ -202737,9 +202966,9 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -204848,8 +205077,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 - review: &795 + repository: *750 + review: &797 description: The review that was affected. type: object properties: @@ -205087,12 +205316,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -207442,7 +207671,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_reviewer: title: User type: @@ -207528,12 +207757,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -209890,7 +210119,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_team: title: Team description: Groups of organization members that gives permissions @@ -210085,12 +210314,12 @@ webhooks: type: string enum: - review_requested - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -212442,7 +212671,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_reviewer: title: User type: @@ -212529,12 +212758,12 @@ webhooks: type: string enum: - review_requested - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -214877,7 +215106,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_team: title: Team description: Groups of organization members that gives permissions @@ -215061,9 +215290,9 @@ webhooks: type: string enum: - submitted - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -217302,8 +217531,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 - review: *795 + repository: *750 + review: *797 sender: *4 required: - action @@ -217383,9 +217612,9 @@ webhooks: type: string enum: - resolved - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -219533,7 +219762,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 + repository: *750 sender: *4 thread: type: object @@ -219930,9 +220159,9 @@ webhooks: type: string enum: - unresolved - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -222063,7 +222292,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 + repository: *750 sender: *4 thread: type: object @@ -222396,7 +222625,7 @@ webhooks: - repository - organization - app - pull-request-synchronize: + pull-request-stacked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -222404,10 +222633,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request's head branch was updated. For example, the head - branch was updated from the base branch or new commits were pushed to the - head branch. - operationId: pull-request/synchronize + description: A pull request was added to a stack. + operationId: pull-request/stacked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -222451,21 +222678,17 @@ webhooks: content: application/json: schema: - title: pull_request synchronize event + title: pull_request stacked event type: object properties: action: type: string enum: - - synchronize - after: - type: string - before: - type: string - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + - stacked + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -223477,13 +223700,17 @@ webhooks: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -223698,15 +223925,23 @@ webhooks: master_branch: type: string merge_commit_message: - description: The default value for a merge commit message. + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: The default value for a merge commit message - title. + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string enum: - PR_TITLE @@ -224209,6 +224444,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -224803,13 +225039,11 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action - number - - before - - after - pull_request - repository - sender @@ -224825,7 +225059,7 @@ webhooks: - repository - organization - app - pull-request-unassigned: + pull-request-synchronize: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -224833,8 +225067,10 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A user was unassigned from a pull request. - operationId: pull-request/unassigned + description: A pull request's head branch was updated. For example, the head + branch was updated from the base branch or new commits were pushed to the + head branch. + operationId: pull-request/synchronize externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -224878,18 +225114,21 @@ webhooks: content: application/json: schema: - title: pull_request unassigned event + title: pull_request synchronize event type: object properties: action: type: string enum: - - unassigned - assignee: *796 - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + - synchronize + after: + type: string + before: + type: string + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -225251,9 +225490,7 @@ webhooks: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: @@ -225903,17 +226140,13 @@ webhooks: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -226128,23 +226361,15 @@ webhooks: master_branch: type: string merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. + description: The default value for a merge commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + description: The default value for a merge commit message + title. type: string enum: - PR_TITLE @@ -226647,7 +226872,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -227242,13 +227466,16 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action - number + - before + - after - pull_request - repository + - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -227261,7 +227488,7 @@ webhooks: - repository - organization - app - pull-request-unlabeled: + pull-request-unassigned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -227269,8 +227496,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was removed from a pull request. - operationId: pull-request/unlabeled + description: A user was unassigned from a pull request. + operationId: pull-request/unassigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -227314,18 +227541,18 @@ webhooks: content: application/json: schema: - title: pull_request unlabeled event + title: pull_request unassigned event type: object properties: action: type: string enum: - - unlabeled - enterprise: *745 - installation: *746 - label: *764 - number: *790 - organization: *747 + - unassigned + assignee: *798 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -227684,656 +227911,6 @@ webhooks: - commit_title - commit_message base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: - - string - - 'null' - changed_files: - type: integer - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: type: object properties: label: @@ -228345,9 +227922,7 @@ webhooks: repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -228562,15 +228137,677 @@ webhooks: master_branch: type: string merge_commit_message: - description: The default value for a merge commit message. + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: The default value for a merge commit message - title. + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a + draft. + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string enum: - PR_TITLE @@ -229073,6 +229310,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -229667,14 +229905,13 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action - number - pull_request - repository - - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -229687,7 +229924,7 @@ webhooks: - repository - organization - app - pull-request-unlocked: + pull-request-unlabeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -229695,9 +229932,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was unlocked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/unlocked + description: A label was removed from a pull request. + operationId: pull-request/unlabeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -229741,17 +229977,18 @@ webhooks: content: application/json: schema: - title: pull_request unlocked event + title: pull_request unlabeled event type: object properties: action: type: string enum: - - unlocked - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + - unlabeled + enterprise: *747 + installation: *748 + label: *766 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -229915,6 +230152,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -229988,6 +230226,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -230021,7 +230260,9 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -230759,7 +231000,9 @@ webhooks: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: @@ -230982,23 +231225,15 @@ webhooks: master_branch: type: string merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. + description: The default value for a merge commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + description: The default value for a merge commit message + title. type: string enum: - PR_TITLE @@ -231589,6 +231824,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -231732,6 +231968,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -231843,6 +232080,15 @@ webhooks: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -232039,6 +232285,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -232083,7 +232330,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -232103,20 +232350,19 @@ webhooks: - repository - organization - app - push: + pull-request-unlocked: post: summary: |- - This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch - and tag deletions, use the [`delete`](#delete) webhook event. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. - operationId: push + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Conversation on a pull request was unlocked. For more information, + see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/unlocked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#push + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -232130,7 +232376,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: push + example: pull_request schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -232158,500 +232404,2917 @@ webhooks: content: application/json: schema: - title: push event + title: pull_request unlocked event type: object properties: - after: - description: The SHA of the most recent commit on `ref` after the - push. - type: string - base_ref: - type: - - string - - 'null' - before: - description: The SHA of the most recent commit on `ref` before the - push. - type: string - commits: - description: An array of commit objects describing the pushed commits. - (Pushed commits are all commits that are included in the `compare` - between the `before` commit and the `after` commit.) The array - includes a maximum of 2048 commits. If necessary, you can use - the [Commits API](https://docs.github.com/rest/commits) to fetch - additional commits. - type: array - items: - title: Commit - type: object - properties: - added: - description: An array of files added in the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that - have been pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - compare: - description: URL that shows the changes in this `ref` update, from - the `before` commit to the `after` commit. For a newly created - `ref` that is directly based on the default branch, this is the - comparison between the head of the default branch and the `after` - commit. Otherwise, this shows all commits until the `after` commit. - type: string - created: - description: Whether this push created the `ref`. - type: boolean - deleted: - description: Whether this push deleted the `ref`. - type: boolean - enterprise: *745 - forced: - description: Whether this push was a force push of the `ref`. - type: boolean - head_commit: - title: Commit - type: - - object - - 'null' - properties: - added: - description: An array of files added in the commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that have - been pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - installation: *746 - organization: *747 - pusher: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - name - ref: - description: 'The full git ref that was pushed. Example: `refs/heads/main` - or `refs/tags/v3.14.1`.' + action: type: string - repository: - title: Repository - description: A git repository + enum: + - unlocked + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: + title: Pull Request type: object properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: + _links: 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 - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create pull requests: - all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: type: - string - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: type: integer - organization: - type: string - owner: + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a + draft. + type: boolean + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull + request. + type: boolean + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within + its repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: + - boolean + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have + for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + repository: *750 + sender: *4 + required: + - action + - number + - pull_request + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app + push: + post: + summary: |- + This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, + when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch + and tag deletions, use the [`delete`](#delete) webhook event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + + > [!NOTE] + > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. + operationId: push + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#push + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: push + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: push event + type: object + properties: + after: + description: The SHA of the most recent commit on `ref` after the + push. + type: string + base_ref: + type: + - string + - 'null' + before: + description: The SHA of the most recent commit on `ref` before the + push. + type: string + commits: + description: An array of commit objects describing the pushed commits. + (Pushed commits are all commits that are included in the `compare` + between the `before` commit and the `after` commit.) The array + includes a maximum of 2048 commits. If necessary, you can use + the [Commits API](https://docs.github.com/rest/commits) to fetch + additional commits. + type: array + items: + title: Commit + type: object + properties: + added: + description: An array of files added in the commit. A maximum + of 3000 changed files will be reported per commit. + type: array + items: + type: string + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + distinct: + description: Whether this commit is distinct from any that + have been pushed before. + type: boolean + id: + type: string + message: + description: The commit message. + type: string + modified: + description: An array of files modified by the commit. A maximum + of 3000 changed files will be reported per commit. + type: array + items: + type: string + removed: + description: An array of files removed in the commit. A maximum + of 3000 changed files will be reported per commit. + type: array + items: + type: string + timestamp: + description: The ISO 8601 timestamp of the commit. + type: string + format: date-time + tree_id: + type: string + url: + description: URL that points to the commit API resource. + type: string + format: uri + required: + - id + - tree_id + - distinct + - message + - timestamp + - url + - author + - committer + compare: + description: URL that shows the changes in this `ref` update, from + the `before` commit to the `after` commit. For a newly created + `ref` that is directly based on the default branch, this is the + comparison between the head of the default branch and the `after` + commit. Otherwise, this shows all commits until the `after` commit. + type: string + created: + description: Whether this push created the `ref`. + type: boolean + deleted: + description: Whether this push deleted the `ref`. + type: boolean + enterprise: *747 + forced: + description: Whether this push was a force push of the `ref`. + type: boolean + head_commit: + title: Commit + type: + - object + - 'null' + properties: + added: + description: An array of files added in the commit. + type: array + items: + type: string + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + distinct: + description: Whether this commit is distinct from any that have + been pushed before. + type: boolean + id: + type: string + message: + description: The commit message. + type: string + modified: + description: An array of files modified by the commit. + type: array + items: + type: string + removed: + description: An array of files removed in the commit. + type: array + items: + type: string + timestamp: + description: The ISO 8601 timestamp of the commit. + type: string + format: date-time + tree_id: + type: string + url: + description: URL that points to the commit API resource. + type: string + format: uri + required: + - id + - tree_id + - distinct + - message + - timestamp + - url + - author + - committer + installation: *748 + organization: *749 + pusher: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - name + ref: + description: 'The full git ref that was pushed. Example: `refs/heads/main` + or `refs/tags/v3.14.1`.' + type: string + repository: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + 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 + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: title: User type: - object @@ -232981,9 +235644,9 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 registry_package: type: object properties: @@ -233460,7 +236123,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *779 + items: *781 summary: type: string tag_name: @@ -233516,7 +236179,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -233594,9 +236257,9 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 registry_package: type: object properties: @@ -233908,7 +236571,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *779 + items: *781 summary: type: string tag_name: @@ -233958,7 +236621,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -234035,10 +236698,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - release: &797 + enterprise: *747 + installation: *748 + organization: *749 + release: &799 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -234369,7 +237032,7 @@ webhooks: - updated_at - zipball_url - body - repository: *748 + repository: *750 sender: *4 required: - action @@ -234446,11 +237109,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - release: *797 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *799 + repository: *750 sender: *4 required: - action @@ -234567,11 +237230,11 @@ webhooks: type: boolean required: - to - enterprise: *745 - installation: *746 - organization: *747 - release: *797 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *799 + repository: *750 sender: *4 required: - action @@ -234649,9 +237312,9 @@ webhooks: type: string enum: - prereleased - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -234987,7 +237650,7 @@ webhooks: - string - 'null' format: uri - repository: *748 + repository: *750 sender: *4 required: - action @@ -235063,10 +237726,10 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 - release: &798 + enterprise: *747 + installation: *748 + organization: *749 + release: &800 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -235399,7 +238062,7 @@ webhooks: - string - 'null' format: uri - repository: *748 + repository: *750 sender: *4 required: - action @@ -235475,11 +238138,11 @@ webhooks: type: string enum: - released - enterprise: *745 - installation: *746 - organization: *747 - release: *797 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *799 + repository: *750 sender: *4 required: - action @@ -235555,11 +238218,11 @@ webhooks: type: string enum: - unpublished - enterprise: *745 - installation: *746 - organization: *747 - release: *798 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *800 + repository: *750 sender: *4 required: - action @@ -235635,11 +238298,11 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - repository_advisory: *666 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + repository_advisory: *668 sender: *4 required: - action @@ -235715,11 +238378,11 @@ webhooks: type: string enum: - reported - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - repository_advisory: *666 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + repository_advisory: *668 sender: *4 required: - action @@ -235795,10 +238458,10 @@ webhooks: type: string enum: - archived - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -235875,10 +238538,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -235956,10 +238619,10 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -236044,10 +238707,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -236162,10 +238825,10 @@ webhooks: - 'null' items: type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -236237,10 +238900,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 status: type: string @@ -236321,10 +238984,10 @@ webhooks: type: string enum: - privatized - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -236401,10 +239064,10 @@ webhooks: type: string enum: - publicized - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -236498,10 +239161,10 @@ webhooks: - name required: - repository - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -236581,10 +239244,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 repository_ruleset: *323 sender: *4 required: @@ -236663,10 +239326,10 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 repository_ruleset: *323 sender: *4 required: @@ -236745,10 +239408,10 @@ webhooks: type: string enum: - edited - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 repository_ruleset: *323 changes: type: object @@ -237056,10 +239719,10 @@ webhooks: - from required: - owner - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237137,10 +239800,10 @@ webhooks: type: string enum: - unarchived - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237218,7 +239881,7 @@ webhooks: type: string enum: - create - alert: &799 + alert: &801 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -237343,10 +240006,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237556,10 +240219,10 @@ webhooks: type: string enum: - dismissed - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237637,11 +240300,11 @@ webhooks: type: string enum: - reopen - alert: *799 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *801 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237843,10 +240506,10 @@ webhooks: enum: - fixed - open - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237924,7 +240587,7 @@ webhooks: type: string enum: - assigned - alert: &800 + alert: &803 type: object properties: number: *180 @@ -238063,11 +240726,12 @@ webhooks: anyOf: - type: 'null' - *4 + metadata: *802 assignee: *4 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238145,11 +240809,11 @@ webhooks: type: string enum: - created - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238230,11 +240894,11 @@ webhooks: type: string enum: - created - alert: *800 - installation: *746 - location: *801 - organization: *747 - repository: *748 + alert: *803 + installation: *748 + location: *804 + organization: *749 + repository: *750 sender: *4 required: - location @@ -238412,6 +241076,168 @@ webhooks: - repository - organization - app + secret-scanning-alert-metadata-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: Metadata was created for a secret scanning alert. + operationId: secret-scanning-alert/metadata-created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: secret_scanning_alert + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + 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: secret_scanning_alert metadata created event + type: object + properties: + action: + type: string + enum: + - metadata_created + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-metadata-removed: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: Metadata was removed from a secret scanning alert. + operationId: secret-scanning-alert/metadata-removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: secret_scanning_alert + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + 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: secret_scanning_alert metadata removed event + type: object + properties: + action: + type: string + enum: + - metadata_removed + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-publicly-leaked: post: summary: |- @@ -238472,11 +241298,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238554,11 +241380,11 @@ webhooks: type: string enum: - reopened - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238636,11 +241462,11 @@ webhooks: type: string enum: - resolved - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238718,12 +241544,12 @@ webhooks: type: string enum: - unassigned - alert: *800 + alert: *803 assignee: *4 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238801,11 +241627,11 @@ webhooks: type: string enum: - validated - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238935,10 +241761,10 @@ webhooks: - organization - enterprise - - repository: *748 - enterprise: *745 - installation: *746 - organization: *747 + repository: *750 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -239016,11 +241842,11 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - security_advisory: &802 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + security_advisory: &805 description: The details of the security advisory, including summary, description, and severity. type: object @@ -239193,11 +242019,11 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - security_advisory: *802 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + security_advisory: *805 sender: *4 required: - action @@ -239270,10 +242096,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -239447,9 +242273,9 @@ webhooks: type: object properties: security_and_analysis: *296 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: *340 sender: *4 required: @@ -239528,12 +242354,12 @@ webhooks: type: string enum: - cancelled - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: &803 + sponsorship: &806 type: object properties: created_at: @@ -239838,12 +242664,12 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - sponsorship @@ -239931,12 +242757,12 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - changes @@ -240013,17 +242839,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &804 + effective_date: &807 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - sponsorship @@ -240097,7 +242923,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &805 + changes: &808 type: object properties: tier: @@ -240141,13 +242967,13 @@ webhooks: - from required: - tier - effective_date: *804 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + effective_date: *807 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - changes @@ -240224,13 +243050,13 @@ webhooks: type: string enum: - tier_changed - changes: *805 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + changes: *808 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - changes @@ -240304,10 +243130,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -240391,10 +243217,10 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -240828,15 +243654,15 @@ webhooks: type: - string - 'null' - enterprise: *745 + enterprise: *747 id: description: The unique identifier of the status. type: integer - installation: *746 + installation: *748 name: type: string - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 sha: description: The Commit SHA. @@ -240952,9 +243778,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -241043,9 +243869,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -241134,9 +243960,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -241225,9 +244051,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -241303,12 +244129,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - team: &806 + team: &809 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -241538,9 +244364,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -242010,7 +244836,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -242086,9 +244912,9 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -242558,7 +245384,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -242635,9 +245461,9 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -243107,7 +245933,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -243251,9 +246077,9 @@ webhooks: - from required: - permissions - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -243723,7 +246549,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - changes @@ -243801,9 +246627,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -244273,7 +247099,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -244349,10 +247175,10 @@ webhooks: type: string enum: - started - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -244425,17 +247251,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *745 + enterprise: *747 inputs: type: - object - 'null' additionalProperties: true - installation: *746 - organization: *747 + installation: *748 + organization: *749 ref: type: string - repository: *748 + repository: *750 sender: *4 workflow: type: string @@ -244517,10 +247343,10 @@ webhooks: type: string enum: - completed - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: allOf: @@ -244855,10 +247681,10 @@ webhooks: type: string enum: - in_progress - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: allOf: @@ -245219,10 +248045,10 @@ webhooks: type: string enum: - queued - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: type: object @@ -245447,10 +248273,10 @@ webhooks: type: string enum: - waiting - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: type: object @@ -245677,12 +248503,12 @@ webhooks: type: string enum: - completed - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object @@ -246701,12 +249527,12 @@ webhooks: type: string enum: - in_progress - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object @@ -247710,12 +250536,12 @@ webhooks: type: string enum: - requested - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 94e8e35a26..6e7bc9ffe8 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -252389,6 +252389,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -253688,6 +253731,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -255061,6 +255147,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -257198,6 +257327,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -258522,6 +258694,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -259891,6 +260106,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -261480,6 +261738,24 @@ "schema": { "type": "boolean" } + }, + { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -680078,6 +680354,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -681944,6 +682263,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -683110,6 +683472,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -684489,6 +684894,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -686645,6 +687093,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -687826,6 +688317,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -689201,6 +689735,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -690806,6 +691383,24 @@ "schema": { "type": "boolean" } + }, + { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -693968,6 +694563,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -693996,7 +694613,13 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ] } } } @@ -695649,6 +696272,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -695697,6 +696342,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -1572387,11 +1573038,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-stacked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1572458,21 +1573109,15 @@ "content": { "application/json": { "schema": { - "title": "pull_request synchronize event", + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "synchronize" + "stacked" ] }, - "after": { - "type": "string" - }, - "before": { - "type": "string" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1574029,7 +1574674,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1574037,7 +1574685,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1574321,7 +1574972,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1574330,7 +1574981,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": [ "PR_TITLE", @@ -1574997,7 +1575648,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1577493,8 +1578145,6 @@ "required": [ "action", "number", - "before", - "after", "pull_request", "repository", "sender" @@ -1577550,11 +1578200,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1577621,114 +1578271,20 @@ "content": { "application/json": { "schema": { - "title": "pull_request unassigned event", + "title": "pull_request synchronize event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unassigned" + "synchronize" ] }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "after": { + "type": "string" + }, + "before": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -1578444,10 +1579000,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1579289,10 +1579842,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1579300,10 +1579850,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1579587,7 +1580134,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1579596,7 +1580143,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1580263,8 +1580810,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -1582760,8 +1583306,11 @@ "required": [ "action", "number", + "before", + "after", "pull_request", - "repository" + "repository", + "sender" ], "x-github-breaking-changes": [ { @@ -1582814,11 +1583363,11 @@ } } }, - "pull-request-unlabeled": { + "pull-request-unassigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1582885,13 +1583434,113 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlabeled event", + "title": "pull_request unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" + "unassigned" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -1583009,49 +1583658,6 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "number": { "description": "The pull request number.", "type": "integer" @@ -1583651,7 +1584257,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1584791,7 +1585400,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1584800,7 +1585409,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": [ "PR_TITLE", @@ -1585467,7 +1586076,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1587964,8 +1588574,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ], "x-github-breaking-changes": [ { @@ -1588018,11 +1588627,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1588089,13 +1588698,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlocked event", + "title": "pull_request unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlocked" + "unlabeled" ] }, "enterprise": { @@ -1588213,6 +1588822,49 @@ "node_id" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "number": { "description": "The pull request number.", "type": "integer" @@ -1588538,7 +1589190,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1588639,7 +1589292,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1588685,7 +1589339,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -1589649,7 +1590306,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1589944,7 +1590604,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1589953,7 +1590613,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1590741,7 +1591401,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1590935,7 +1591596,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1591083,7 +1591745,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -1591346,7 +1592017,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1593159,12 +1593831,13 @@ } } }, - "push": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1593186,7 +1593859,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "push", + "example": "pull_request", "schema": { "type": "string" } @@ -1593229,158 +1593902,15 @@ "content": { "application/json": { "schema": { - "title": "push event", + "title": "pull_request unlocked event", "type": "object", "properties": { - "after": { - "description": "The SHA of the most recent commit on `ref` after the push.", - "type": "string" - }, - "base_ref": { - "type": [ - "string", - "null" + "action": { + "type": "string", + "enum": [ + "unlocked" ] }, - "before": { - "description": "The SHA of the most recent commit on `ref` before the push.", - "type": "string" - }, - "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits.", - "type": "array", - "items": { - "title": "Commit", - "type": "object", - "properties": { - "added": { - "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "distinct": { - "description": "Whether this commit is distinct from any that have been pushed before.", - "type": "boolean" - }, - "id": { - "type": "string" - }, - "message": { - "description": "The commit message.", - "type": "string" - }, - "modified": { - "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "removed": { - "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "timestamp": { - "description": "The ISO 8601 timestamp of the commit.", - "type": "string", - "format": "date-time" - }, - "tree_id": { - "type": "string" - }, - "url": { - "description": "URL that points to the commit API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "tree_id", - "distinct", - "message", - "timestamp", - "url", - "author", - "committer" - ] - } - }, - "compare": { - "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.", - "type": "string" - }, - "created": { - "description": "Whether this push created the `ref`.", - "type": "boolean" - }, - "deleted": { - "description": "Whether this push deleted the `ref`.", - "type": "boolean" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1593471,132 +1594001,6 @@ "avatar_url" ] }, - "forced": { - "description": "Whether this push was a force push of the `ref`.", - "type": "boolean" - }, - "head_commit": { - "title": "Commit", - "type": [ - "object", - "null" - ], - "properties": { - "added": { - "description": "An array of files added in the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "distinct": { - "description": "Whether this commit is distinct from any that have been pushed before.", - "type": "boolean" - }, - "id": { - "type": "string" - }, - "message": { - "description": "The commit message.", - "type": "string" - }, - "modified": { - "description": "An array of files modified by the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "removed": { - "description": "An array of files removed in the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "timestamp": { - "description": "The ISO 8601 timestamp of the commit.", - "type": "string", - "format": "date-time" - }, - "tree_id": { - "type": "string" - }, - "url": { - "description": "URL that points to the commit API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "tree_id", - "distinct", - "message", - "timestamp", - "url", - "author", - "committer" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1593622,6 +1594026,10 @@ "node_id" ] }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1593721,365 +1594129,146 @@ "description" ] }, - "pusher": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "ref": { - "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.", - "type": "string" - }, - "repository": { - "title": "Repository", - "description": "A git repository", + "pull_request": { + "title": "Pull Request", "type": "object", "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "custom_properties": { + "_links": { "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 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "type": "boolean", - "default": true - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], "properties": { - "key": { - "type": "string" + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "name": { - "type": "string" + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "node_id": { - "type": "string" + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "spdx_id": { - "type": "string" + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] } }, "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" ] }, - "master_branch": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { + "active_lock_reason": { "type": [ "string", "null" ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, - "open_issues_count": { + "additions": { "type": "integer" }, - "organization": { - "type": "string" - }, - "owner": { + "assignee": { "title": "User", "type": [ "object", @@ -1594178,864 +1594367,181 @@ "id" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { + "assignees": { "type": "array", "items": { - "type": "string" + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] } }, - "trees_url": { - "type": "string", - "format": "uri-template" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "visibility": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", "enum": [ - "public", - "private", - "internal" - ] - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private", - "owner", - "html_url", - "description", - "fork", - "url", - "forks_url", - "keys_url", - "collaborators_url", - "teams_url", - "hooks_url", - "issue_events_url", - "events_url", - "assignees_url", - "branches_url", - "tags_url", - "blobs_url", - "git_tags_url", - "git_refs_url", - "trees_url", - "statuses_url", - "languages_url", - "stargazers_url", - "contributors_url", - "subscribers_url", - "subscription_url", - "commits_url", - "git_commits_url", - "comments_url", - "issue_comment_url", - "contents_url", - "compare_url", - "merges_url", - "archive_url", - "downloads_url", - "issues_url", - "pulls_url", - "milestones_url", - "notifications_url", - "labels_url", - "releases_url", - "deployments_url", - "created_at", - "updated_at", - "pushed_at", - "git_url", - "ssh_url", - "clone_url", - "svn_url", - "homepage", - "size", - "stargazers_count", - "watchers_count", - "language", - "has_issues", - "has_projects", - "has_downloads", - "has_wiki", - "has_pages", - "has_discussions", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] - }, - "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": [ - "ref", - "before", - "after", - "created", - "deleted", - "forced", - "base_ref", - "compare", - "commits", - "head_commit", - "repository", - "pusher" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "push", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "registry-package-published": { - "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" - }, - "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": "registry_package", - "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": { - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "published" - ] - }, - "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" - ] - }, - "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" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "description": { + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", "type": [ - "string", + "object", "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" - ] - }, - "registry_package": { - "type": "object", - "properties": { - "created_at": { - "type": [ - "string", - "null" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "owner": { - "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" - }, - "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" + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] }, - "url": { + "commit_title": { + "description": "Title for the merge commit message.", "type": "string" }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" - ] - }, - "package_type": { - "type": "string" - }, - "package_version": { - "type": [ - "object", - "null" - ], - "properties": { - "author": { - "type": "object", + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1595043,32 +1594549,46 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" @@ -1595076,469 +1594596,415 @@ }, "required": [ "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" + "id" ] }, - "body": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - "body_html": { + "ref": { "type": "string" }, - "container_metadata": { + "repo": { + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { - "labels": { - "type": [ - "object", - "null" - ] + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false }, - "manifest": { - "type": [ - "object", - "null" - ] + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" }, - "tag": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - } - }, - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "docker_metadata": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "installation_command": { - "type": "string" - }, - "manifest": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - }, - "name": { - "type": "string" - }, - "npm_metadata": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true }, - "version": { - "type": "string" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true }, - "npm_user": { - "type": "string" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true }, - "author": { + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { "oneOf": [ { - "type": "string" + "type": "integer" }, { - "type": "object" + "type": "string", + "format": "date-time" } - ], - "type": [ - "null", - "string", - "object" ] }, - "bugs": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { "type": [ - "null", "string", - "object" + "null" ] }, - "dependencies": { - "type": "object" + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" }, - "dev_dependencies": { - "type": "object" + "downloads_url": { + "type": "string", + "format": "uri" }, - "peer_dependencies": { - "type": "object" + "events_url": { + "type": "string", + "format": "uri" }, - "optional_dependencies": { - "type": "object" + "fork": { + "type": "boolean" }, - "description": { - "type": "string" + "forks": { + "type": "integer" }, - "dist": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], - "type": [ - "null", - "string", - "object" - ] + "forks_count": { + "type": "integer" }, - "git_head": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri" }, - "homepage": { + "full_name": { "type": "string" }, - "license": { - "type": "string" + "git_commits_url": { + "type": "string", + "format": "uri-template" }, - "main": { - "type": "string" + "git_refs_url": { + "type": "string", + "format": "uri-template" }, - "repository": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { "type": [ - "null", "string", - "object" + "null" ] }, - "scripts": { - "type": "object" - }, - "id": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri" }, - "node_version": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "npm_version": { - "type": "string" + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" }, - "has_shrinkwrap": { + "is_template": { "type": "boolean" }, - "maintainers": { - "type": "array", - "items": { - "type": "string" - } + "issue_comment_url": { + "type": "string", + "format": "uri-template" }, - "contributors": { - "type": "array", - "items": { - "type": "string" - } + "issue_events_url": { + "type": "string", + "format": "uri-template" }, - "engines": { - "type": "object" + "issues_url": { + "type": "string", + "format": "uri-template" }, - "keywords": { - "type": "array", - "items": { - "type": "string" - } + "keys_url": { + "type": "string", + "format": "uri-template" }, - "files": { - "type": "array", - "items": { - "type": "string" - } + "labels_url": { + "type": "string", + "format": "uri-template" }, - "bin": { - "type": "object" + "language": { + "type": [ + "string", + "null" + ] }, - "man": { - "type": "object" + "languages_url": { + "type": "string", + "format": "uri" }, - "directories": { - "oneOf": [ - { + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { "type": "string" }, - { - "type": "object" + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } - ], - "type": [ - "null", - "string", - "object" + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" ] }, - "os": { - "type": "array", - "items": { - "type": "string" - } + "master_branch": { + "type": "string" }, - "cpu": { - "type": "array", - "items": { - "type": "string" - } + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] }, - "readme": { + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", "type": "string" }, - "installation_command": { + "node_id": { "type": "string" }, - "release_id": { + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { "type": "integer" }, - "commit_oid": { - "type": "string" + "open_issues_count": { + "type": "integer" }, - "published_via_actions": { - "type": "boolean" + "organization": { + "type": "string" }, - "deleted_by_id": { - "type": "integer" - } - } - }, - "nuget_metadata": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "object", - "integer" - ] - }, - "name": { - "type": "string" - }, - "value": { - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "branch": { - "type": "string" - }, - "commit": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - ] - } - } - } - }, - "package_files": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "md5": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "sha1": { - "type": [ - "string", - "null" - ] - }, - "sha256": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "state": { - "type": [ - "string", - "null" - ] - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "download_url", - "id", - "name", - "sha256", - "sha1", - "md5", - "content_type", - "state", - "size", - "created_at", - "updated_at" - ] - } - }, - "package_url": { - "type": "string" - }, - "prerelease": { - "type": "boolean" - }, - "release": { - "type": "object", - "properties": { - "author": { - "type": "object", + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1595546,510 +1595012,1357 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, - "created_at": { - "type": "string" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] }, - "draft": { + "private": { + "description": "Whether the repository is private or public.", "type": "boolean" }, - "html_url": { + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { "type": "string" }, - "id": { + "stargazers": { "type": "integer" }, - "name": { + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" ] }, - "prerelease": { - "type": "boolean" + "events_url": { + "type": "string", + "format": "uri-template" }, - "published_at": { + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "tag_name": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { "type": "string" }, - "target_commitish": { + "name": { + "type": "string" + }, + "node_id": { "type": "string" }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { "type": "string" } - } - }, - "rubygems_metadata": { - "type": "array", - "items": { - "title": "Ruby Gems metadata", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "readme": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "version_info": { - "type": "object", - "properties": { - "version": { - "type": "string" - } - } - }, - "platform": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repo": { - "type": "string" - }, - "dependencies": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "commit_oid": { - "type": "string" - } - } - } - }, - "summary": { - "type": "string" - }, - "tag_name": { - "type": "string" - }, - "target_commitish": { - "type": "string" - }, - "target_oid": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "version": { - "type": "string" + }, + "required": [ + "login", + "id" + ] } }, "required": [ - "id", - "version", - "name", - "description", - "summary", - "html_url", - "metadata", - "package_files", - "installation_command", - "package_url" + "label", + "ref", + "sha", + "user", + "repo" ] }, - "registry": { + "body": { "type": [ - "object", + "string", "null" - ], - "properties": { - "about_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - }, - "vendor": { - "type": "string" - } - } + ] }, - "updated_at": { + "changed_files": { + "type": "integer" + }, + "closed_at": { "type": [ "string", "null" - ] - } - }, - "required": [ - "id", - "name", - "namespace", - "description", - "ecosystem", - "package_type", - "html_url", - "created_at", - "updated_at", - "owner", - "package_version", - "registry" - ] - }, - "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 - ] + ], + "format": "date-time" }, - "node_id": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "format": "uri" }, - "name": { - "description": "The name of the repository.", + "commits": { + "type": "integer" + }, + "commits_url": { "type": "string", - "examples": [ - "Team Environment" - ] + "format": "uri" }, - "full_name": { + "created_at": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "format": "date-time" }, - "license": { - "anyOf": [ - { - "type": "null" + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], "properties": { - "key": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { "type": "string", - "examples": [ - "mit" - ] + "format": "uri-template" }, - "name": { + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { "type": "string", - "examples": [ - "MIT License" + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } ] }, - "url": { + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" ] }, - "spdx_id": { + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { "type": [ "string", "null" - ], - "examples": [ - "MIT" ] }, - "node_id": { + "hooks_url": { "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "format": "uri" }, "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": { + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { "type": [ "string", "null" ] }, - "email": { + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", "type": [ - "string", + "object", "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" ] }, - "login": { + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", - "examples": [ - "octocat" + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" ] }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" ] }, - "node_id": { + "merges_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri" }, - "avatar_url": { + "milestones_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, - "gravatar_id": { + "mirror_url": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "format": "uri" }, - "url": { + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" ] }, - "followers_url": { + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" ] }, - "following_url": { + "releases_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" ] }, - "gists_url": { + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" ] }, - "starred_url": { + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" ] }, - "subscriptions_url": { + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "statuses_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" ] }, - "repos_url": { + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" ] }, "events_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "uri" }, - "type": { + "repos_url": { "type": "string", - "examples": [ - "User" - ] + "format": "uri" }, "site_admin": { "type": "boolean" }, - "starred_at": { + "starred_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri-template" }, - "user_view_type": { + "subscriptions_url": { "type": "string", - "examples": [ - "public" + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "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" + "id" ] } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" ] }, - "forks": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" }, "email": { "type": [ @@ -1596057,220 +1596370,1379 @@ "null" ] }, - "login": { + "events_url": { "type": "string", - "examples": [ - "octocat" - ] + "format": "uri-template" }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "following_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "format": "uri" }, - "following_url": { + "received_events_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "format": "uri" }, - "gists_url": { + "repos_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "format": "uri" + }, + "site_admin": { + "type": "boolean" }, "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "format": "uri-template" }, "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "repos_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "description": { + "type": [ + "string", + "null" ] }, - "type": { + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { "type": "string", - "examples": [ - "User" - ] + "format": "uri" }, - "site_admin": { - "type": "boolean" + "id": { + "type": "integer" }, - "starred_at": { + "labels_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" }, - "user_view_type": { + "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", - "examples": [ - "public" + "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": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "url", "html_url", + "labels_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "node_id": { + "type": "string" }, - "html_url": { + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "format": "uri" }, - "description": { + "rebaseable": { "type": [ - "string", + "boolean", "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", + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] @@ -1597444,8 +1598916,40 @@ }, "required": [ "action", - "registry_package", + "number", + "pull_request", + "repository", "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } ] } } @@ -1597459,7 +1598963,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -1597468,13 +1598972,12 @@ } } }, - "registry-package-updated": { + "push": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1597496,7 +1598999,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "registry_package", + "example": "push", "schema": { "type": "string" } @@ -1597539,14 +1599042,158 @@ "content": { "application/json": { "schema": { + "title": "push event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "updated" + "after": { + "description": "The SHA of the most recent commit on `ref` after the push.", + "type": "string" + }, + "base_ref": { + "type": [ + "string", + "null" ] }, + "before": { + "description": "The SHA of the most recent commit on `ref` before the push.", + "type": "string" + }, + "commits": { + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits.", + "type": "array", + "items": { + "title": "Commit", + "type": "object", + "properties": { + "added": { + "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + } + }, + "compare": { + "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.", + "type": "string" + }, + "created": { + "description": "Whether this push created the `ref`.", + "type": "boolean" + }, + "deleted": { + "description": "Whether this push deleted the `ref`.", + "type": "boolean" + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1597637,6 +1599284,132 @@ "avatar_url" ] }, + "forced": { + "description": "Whether this push was a force push of the `ref`.", + "type": "boolean" + }, + "head_commit": { + "title": "Commit", + "type": [ + "object", + "null" + ], + "properties": { + "added": { + "description": "An array of files added in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1597761,55 +1599534,406 @@ "description" ] }, - "registry_package": { + "pusher": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "ref": { + "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.", + "type": "string" + }, + "repository": { + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "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 + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string" }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, "description": { "type": [ + "string", "null" ] }, - "ecosystem": { + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { "type": "string" }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { - "type": "integer" + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, "name": { + "description": "The name of the repository.", "type": "string" }, - "namespace": { + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { "type": "string" }, "owner": { - "type": "object", + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1597817,32 +1599941,46 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" @@ -1597850,222 +1599988,1346 @@ }, "required": [ "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" + "id" ] }, - "package_type": { - "type": "string" - }, - "package_version": { + "permissions": { "type": "object", "properties": { - "author": { - "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" - }, - "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": [ - "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" - ] - }, - "body": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "docker_metadata": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ], - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "draft": { + "admin": { "type": "boolean" }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "installation_command": { - "type": "string" - }, - "manifest": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - }, - "name": { - "type": "string" + "maintain": { + "type": "boolean" }, - "package_files": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "md5": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "sha1": { - "type": [ - "string", - "null" - ] - }, - "sha256": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } + "pull": { + "type": "boolean" }, - "package_url": { - "type": "string" + "push": { + "type": "boolean" }, - "prerelease": { + "triage": { "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" }, - "release": { - "type": "object", + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "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": [ + "ref", + "before", + "after", + "created", + "deleted", + "forced", + "base_ref", + "compare", + "commits", + "head_commit", + "repository", + "pusher" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "push", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "registry-package-published": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + }, + "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": "registry_package", + "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": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" + ] + }, + "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" + ] + }, + "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" + ] + }, + "registry_package": { + "type": "object", + "properties": { + "created_at": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { + "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" + }, + "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": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "package_type": { + "type": "string" + }, + "package_version": { + "type": [ + "object", + "null" + ], + "properties": { + "author": { + "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" + }, + "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": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "body": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "body_html": { + "type": "string" + }, + "container_metadata": { + "type": "object", + "properties": { + "labels": { + "type": [ + "object", + "null" + ] + }, + "manifest": { + "type": [ + "object", + "null" + ] + }, + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "npm_metadata": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "npm_user": { + "type": "string" + }, + "author": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "bugs": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "dependencies": { + "type": "object" + }, + "dev_dependencies": { + "type": "object" + }, + "peer_dependencies": { + "type": "object" + }, + "optional_dependencies": { + "type": "object" + }, + "description": { + "type": "string" + }, + "dist": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "git_head": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "license": { + "type": "string" + }, + "main": { + "type": "string" + }, + "repository": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "scripts": { + "type": "object" + }, + "id": { + "type": "string" + }, + "node_version": { + "type": "string" + }, + "npm_version": { + "type": "string" + }, + "has_shrinkwrap": { + "type": "boolean" + }, + "maintainers": { + "type": "array", + "items": { + "type": "string" + } + }, + "contributors": { + "type": "array", + "items": { + "type": "string" + } + }, + "engines": { + "type": "object" + }, + "keywords": { + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + }, + "bin": { + "type": "object" + }, + "man": { + "type": "object" + }, + "directories": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "os": { + "type": "array", + "items": { + "type": "string" + } + }, + "cpu": { + "type": "array", + "items": { + "type": "string" + } + }, + "readme": { + "type": "string" + }, + "installation_command": { + "type": "string" + }, + "release_id": { + "type": "integer" + }, + "commit_oid": { + "type": "string" + }, + "published_via_actions": { + "type": "boolean" + }, + "deleted_by_id": { + "type": "integer" + } + } + }, + "nuget_metadata": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "object", + "integer" + ] + }, + "name": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "commit": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + ] + } + } + } + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "sha1": { + "type": [ + "string", + "null" + ] + }, + "sha256": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "state": { + "type": [ + "string", + "null" + ] + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "download_url", + "id", + "name", + "sha256", + "sha1", + "md5", + "content_type", + "state", + "size", + "created_at", + "updated_at" + ] + } + }, + "package_url": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "release": { + "type": "object", "properties": { "author": { "type": "object", @@ -1598127,27 +1601389,7 @@ "user_view_type": { "type": "string" } - }, - "required": [ - "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" - ] + } }, "created_at": { "type": "string" @@ -1598162,7 +1601404,10 @@ "type": "integer" }, "name": { - "type": "string" + "type": [ + "string", + "null" + ] }, "prerelease": { "type": "boolean" @@ -1598179,20 +1601424,7 @@ "url": { "type": "string" } - }, - "required": [ - "url", - "html_url", - "id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "created_at", - "published_at" - ] + } }, "rubygems_metadata": { "type": "array", @@ -1598272,16 +1601504,9 @@ "name", "description", "summary", - "body", - "body_html", "html_url", - "target_commitish", - "target_oid", - "created_at", - "updated_at", "metadata", "package_files", - "author", "installation_command", "package_url" ] @@ -1598290,10 +1601515,30 @@ "type": [ "object", "null" - ] + ], + "properties": { + "about_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "vendor": { + "type": "string" + } + } }, "updated_at": { - "type": "string" + "type": [ + "string", + "null" + ] } }, "required": [ @@ -1600036,13 +1603281,13 @@ } } }, - "release-created": { + "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -1600064,7 +1603309,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -1600107,13 +1603352,12 @@ "content": { "application/json": { "schema": { - "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "updated" ] }, "enterprise": { @@ -1600330,232 +1603574,55 @@ "description" ] }, - "release": { - "title": "Release", - "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "registry_package": { "type": "object", "properties": { - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "download_count": { - "type": "integer" - }, - "id": { - "type": "integer" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ] - } - }, - "assets_url": { - "type": "string", - "format": "uri" + "created_at": { + "type": "string" }, - "author": { - "title": "User", + "description": { "type": [ - "object", "null" - ], + ] + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { + "type": "object", "properties": { "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] + "type": "string" }, "events_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "followers_url": { - "type": "string", - "format": "uri" + "type": "string" }, "following_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gists_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" @@ -1600563,46 +1603630,32 @@ "login": { "type": "string" }, - "name": { - "type": "string" - }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string", - "format": "uri" + "type": "string" }, "received_events_url": { - "type": "string", - "format": "uri" + "type": "string" }, "repos_url": { - "type": "string", - "format": "uri" + "type": "string" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "subscriptions_url": { - "type": "string", - "format": "uri" + "type": "string" }, "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "type": "string" }, "url": { - "type": "string", - "format": "uri" + "type": "string" }, "user_view_type": { "type": "string" @@ -1600610,385 +1603663,681 @@ }, "required": [ "login", - "id" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri" - }, - "draft": { - "description": "Whether the release is a draft or published", - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" ] }, - "node_id": { + "package_type": { "type": "string" }, - "prerelease": { - "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "reactions": { - "title": "Reactions", + "package_version": { "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" - ] - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, - "url": { - "type": "string", - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "assets_url", - "upload_url", - "html_url", - "id", - "node_id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "immutable", - "created_at", - "published_at", - "assets", - "tarball_url", - "updated_at", - "zipball_url", - "body" - ] - }, - "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", + "author": { "type": "object", "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] + "avatar_url": { + "type": "string" }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] + "events_url": { + "type": "string" }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] + "followers_url": { + "type": "string" }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "following_url": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" }, "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" - ] + "type": "string" }, - "email": { - "type": [ - "string", - "null" - ] + "id": { + "type": "integer" }, "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "type": "string" }, "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" - ] + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "organizations_url": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "received_events_url": { + "type": "string" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "repos_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "site_admin": { + "type": "boolean" }, "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "type": "string" }, "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "type": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "url": { + "type": "string" }, - "events_url": { - "type": "string", - "examples": [ + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ], + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "sha1": { + "type": [ + "string", + "null" + ] + }, + "sha256": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "package_url": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "release": { + "type": "object", + "properties": { + "author": { + "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" + }, + "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": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "required": [ + "url", + "html_url", + "id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "created_at", + "published_at" + ] + }, + "rubygems_metadata": { + "type": "array", + "items": { + "title": "Ruby Gems metadata", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "readme": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "version_info": { + "type": "object", + "properties": { + "version": { + "type": "string" + } + } + }, + "platform": { + "type": "string" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repo": { + "type": "string" + }, + "dependencies": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "commit_oid": { + "type": "string" + } + } + } + }, + "summary": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "target_oid": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "required": [ + "id", + "version", + "name", + "description", + "summary", + "body", + "body_html", + "html_url", + "target_commitish", + "target_oid", + "created_at", + "updated_at", + "metadata", + "package_files", + "author", + "installation_command", + "package_url" + ] + }, + "registry": { + "type": [ + "object", + "null" + ] + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", + "created_at", + "updated_at", + "owner", + "package_version", + "registry" + ] + }, + "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}" ] }, @@ -1602476,8 +1605825,7 @@ }, "required": [ "action", - "release", - "repository", + "registry_package", "sender" ] } @@ -1602492,7 +1605840,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -1602501,11 +1605849,11 @@ } } }, - "release-deleted": { + "release-created": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1602572,13 +1605920,13 @@ "content": { "application/json": { "schema": { - "title": "release deleted event", + "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "created" ] }, "enterprise": { @@ -1604966,11 +1608314,11 @@ } } }, - "release-edited": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "description": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1605037,68 +1608385,15 @@ "content": { "application/json": { "schema": { - "title": "release edited event", + "title": "release deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "deleted" ] }, - "changes": { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "name": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the name if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "tag_name": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the tag_name if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "make_latest": { - "type": "object", - "properties": { - "to": { - "description": "Whether this release was explicitly `edited` to be the latest.", - "type": "boolean" - } - }, - "required": [ - "to" - ] - } - } - }, "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).\"", @@ -1607459,9 +1610754,9 @@ }, "required": [ "action", - "changes", "release", - "repository" + "repository", + "sender" ] } } @@ -1607484,11 +1610779,11 @@ } } }, - "release-prereleased": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1607555,15 +1610850,68 @@ "content": { "application/json": { "schema": { - "title": "release prereleased event", + "title": "release edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "prereleased" + "edited" ] }, + "changes": { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "tag_name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the tag_name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "make_latest": { + "type": "object", + "properties": { + "to": { + "description": "Whether this release was explicitly `edited` to be the latest.", + "type": "boolean" + } + }, + "required": [ + "to" + ] + } + } + }, "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).\"", @@ -1607782,53 +1611130,13 @@ "title": "Release", "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", "type": "object", - "required": [ - "assets", - "assets_url", - "author", - "body", - "created_at", - "draft", - "html_url", - "id", - "immutable", - "name", - "node_id", - "prerelease", - "published_at", - "tag_name", - "tarball_url", - "target_commitish", - "updated_at", - "upload_url", - "url", - "zipball_url" - ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": [ - "object", - "null" - ], - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ], + "type": "object", "properties": { "browser_download_url": { "type": "string", @@ -1607886,10 +1611194,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1607974,13 +1611278,32 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "login", + "id" + ] }, "url": { "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "digest", + "content_type", + "size", + "download_count", + "created_at", + "updated_at" + ] } }, "assets_url": { @@ -1607993,10 +1611316,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1608084,7 +1611403,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": [ @@ -1608099,6 +1611422,13 @@ ], "format": "date-time" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1608129,10 +1611459,7 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean", - "enum": [ - true - ] + "type": "boolean" }, "published_at": { "type": [ @@ -1608144,18 +1611471,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1608188,7 +1611503,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "tag_name": { "description": "The name of the tag.", @@ -1608209,13 +1611536,6 @@ "type": "string", "format": "uri-template" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "url": { "type": "string", "format": "uri" @@ -1608227,7 +1611547,29 @@ ], "format": "uri" } - } + }, + "required": [ + "url", + "assets_url", + "upload_url", + "html_url", + "id", + "node_id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "immutable", + "created_at", + "published_at", + "assets", + "tarball_url", + "updated_at", + "zipball_url", + "body" + ] }, "repository": { "title": "Repository", @@ -1609930,6 +1613272,7 @@ }, "required": [ "action", + "changes", "release", "repository" ] @@ -1609954,11 +1613297,11 @@ } } }, - "release-published": { + "release-prereleased": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1610025,13 +1613368,13 @@ "content": { "application/json": { "schema": { - "title": "release published event", + "title": "release prereleased event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "prereleased" ] }, "enterprise": { @@ -1610261,10 +1613604,10 @@ "draft", "html_url", "id", + "immutable", "name", "node_id", "prerelease", - "immutable", "published_at", "tag_name", "tarball_url", @@ -1610292,9 +1613635,9 @@ "name", "label", "state", + "digest", "content_type", "size", - "digest", "download_count", "created_at", "updated_at" @@ -1610599,7 +1613942,10 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" + "type": "boolean", + "enum": [ + true + ] }, "published_at": { "type": [ @@ -1610672,6 +1614018,10 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, "updated_at": { "type": [ "string", @@ -1610679,10 +1614029,6 @@ ], "format": "date-time" }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, "url": { "type": "string", "format": "uri" @@ -1612421,11 +1615767,11 @@ } } }, - "release-released": { + "release-published": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1612492,13 +1615838,13 @@ "content": { "application/json": { "schema": { - "title": "release released event", + "title": "release published event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "released" + "published" ] }, "enterprise": { @@ -1612719,13 +1616065,53 @@ "title": "Release", "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", "type": "object", + "required": [ + "assets", + "assets_url", + "author", + "body", + "created_at", + "draft", + "html_url", + "id", + "name", + "node_id", + "prerelease", + "immutable", + "published_at", + "tag_name", + "tarball_url", + "target_commitish", + "updated_at", + "upload_url", + "url", + "zipball_url" + ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": "object", + "type": [ + "object", + "null" + ], + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], "properties": { "browser_download_url": { "type": "string", @@ -1612783,6 +1616169,10 @@ "object", "null" ], + "required": [ + "login", + "id" + ], "properties": { "avatar_url": { "type": "string", @@ -1612867,32 +1616257,13 @@ "type": "string", "format": "uri" } - }, - "required": [ - "login", - "id" - ] + } }, "url": { "type": "string", "format": "uri" } - }, - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ] + } } }, "assets_url": { @@ -1612905,6 +1616276,10 @@ "object", "null" ], + "required": [ + "login", + "id" + ], "properties": { "avatar_url": { "type": "string", @@ -1612992,11 +1616367,7 @@ "user_view_type": { "type": "string" } - }, - "required": [ - "login", - "id" - ] + } }, "body": { "type": [ @@ -1613011,13 +1616382,6 @@ ], "format": "date-time" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "discussion_url": { "type": "string", "format": "uri" @@ -1613060,6 +1616424,18 @@ "reactions": { "title": "Reactions", "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], "properties": { "+1": { "type": "integer" @@ -1613092,19 +1616468,7 @@ "type": "string", "format": "uri" } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + } }, "tag_name": { "description": "The name of the tag.", @@ -1613121,6 +1616485,13 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "upload_url": { "type": "string", "format": "uri-template" @@ -1613136,29 +1616507,7 @@ ], "format": "uri" } - }, - "required": [ - "url", - "assets_url", - "upload_url", - "html_url", - "id", - "node_id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "immutable", - "created_at", - "published_at", - "assets", - "tarball_url", - "updated_at", - "zipball_url", - "body" - ] + } }, "repository": { "title": "Repository", @@ -1614885,11 +1618234,11 @@ } } }, - "release-unpublished": { + "release-released": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release or pre-release was unpublished.", - "operationId": "release/unpublished", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -1614956,13 +1618305,13 @@ "content": { "application/json": { "schema": { - "title": "release unpublished event", + "title": "release released event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unpublished" + "released" ] }, "enterprise": { @@ -1615183,53 +1618532,13 @@ "title": "Release", "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", "type": "object", - "required": [ - "assets", - "assets_url", - "author", - "body", - "created_at", - "draft", - "html_url", - "id", - "name", - "node_id", - "prerelease", - "immutable", - "published_at", - "tag_name", - "tarball_url", - "target_commitish", - "updated_at", - "upload_url", - "url", - "zipball_url" - ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": [ - "object", - "null" - ], - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "content_type", - "size", - "digest", - "download_count", - "created_at", - "updated_at" - ], + "type": "object", "properties": { "browser_download_url": { "type": "string", @@ -1615287,10 +1618596,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1615375,13 +1618680,32 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "login", + "id" + ] }, "url": { "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "digest", + "content_type", + "size", + "download_count", + "created_at", + "updated_at" + ] } }, "assets_url": { @@ -1615394,10 +1618718,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1615485,7 +1618805,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": [ @@ -1615500,6 +1618824,13 @@ ], "format": "date-time" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1615542,18 +1618873,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1615586,7 +1618905,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "tag_name": { "description": "The name of the tag.", @@ -1615603,13 +1618934,6 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "upload_url": { "type": "string", "format": "uri-template" @@ -1615625,7 +1618949,29 @@ ], "format": "uri" } - } + }, + "required": [ + "url", + "assets_url", + "upload_url", + "html_url", + "id", + "node_id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "immutable", + "created_at", + "published_at", + "assets", + "tarball_url", + "updated_at", + "zipball_url", + "body" + ] }, "repository": { "title": "Repository", @@ -1617352,13 +1620698,13 @@ } } }, - "repository-advisory-published": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A repository security advisory was published.", - "operationId": "repository-advisory/published", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1617380,7 +1620726,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -1617423,13 +1620769,2480 @@ "content": { "application/json": { "schema": { - "title": "Repository advisory published event", + "title": "release unpublished event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "unpublished" + ] + }, + "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" + ] + }, + "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" + ] + }, + "release": { + "title": "Release", + "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "type": "object", + "required": [ + "assets", + "assets_url", + "author", + "body", + "created_at", + "draft", + "html_url", + "id", + "name", + "node_id", + "prerelease", + "immutable", + "published_at", + "tag_name", + "tarball_url", + "target_commitish", + "updated_at", + "upload_url", + "url", + "zipball_url" + ], + "properties": { + "assets": { + "type": "array", + "items": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": [ + "object", + "null" + ], + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], + "properties": { + "browser_download_url": { + "type": "string", + "format": "uri" + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "download_count": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "label": { + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": [ + "string", + "null" + ] + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "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" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "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" + } + } + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Whether the release is a draft or published", + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "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" + } + } + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string" + }, + "tarball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + } + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null, + "template_repository": { + "properties": { + "use_squash_pr_title_as_default": null + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + } + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "release", + "repository" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-advisory-published": { + "post": { + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_advisory", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Repository advisory published event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" ] }, "enterprise": { @@ -1646221,6 +1652034,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1649579,6 +1655435,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1652937,6 +1658836,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1654027,57 +1659969,31 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", "type": "object", "properties": { "id": { "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." + "description": "ID of the actor that can dismiss reviews." }, "type": { "type": "string", - "description": "The type of the reviewer", + "description": "The type of the actor", "enum": [ - "Team" + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" ] } }, @@ -1654087,864 +1660003,976 @@ ] } }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } - }, - { - "title": "license_compliance_scanning", - "description": "Enforce any added or changed dependencies to comply with the organization's license policy.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "license_compliance_scanning" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - } - ] - } - }, - "deleted": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, + { + "title": "license_compliance_scanning", + "description": "Enforce any added or changed dependencies to comply with the organization's license policy.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "license_compliance_scanning" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + } + ] + } + }, + "deleted": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" ] }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1655866,6 +1661894,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1656845,206 +1662916,4420 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "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" + ] + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null, + "template_repository": { + "properties": { + "use_squash_pr_title_as_default": null + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + } + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "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" + ] + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null, + "template_repository": { + "properties": { + "use_squash_pr_title_as_default": null + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + } + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-vulnerability-alert-create": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_vulnerability_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { - "type": "object", + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "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" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "auto_dismissed", + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1658961,7 +1669246,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1658977,23 +1669262,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1659015,7 +1669298,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -1659058,15 +1669341,199 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": [ + "string", + "null" + ] + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "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" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1660982,6 +1671449,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1660997,21 +1671465,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1661078,13 +1671544,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1663199,11 +1673665,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1663270,13 +1673736,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1663287,9 +1673753,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1663309,12 +1673772,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": [ - "string", - "null" - ] - }, "dismiss_reason": { "type": "string" }, @@ -1663414,9 +1673871,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1663458,7 +1673912,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1665402,13 +1675857,13 @@ } } }, - "repository-vulnerability-alert-reopen": { + "secret-scanning-alert-assigned": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1665430,7 +1675885,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1665473,187 +1675928,1252 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert reopen event", + "title": "secret_scanning_alert assigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopen" + "assigned" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "email": { - "type": [ - "string", - "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" ] + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" + { + "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" + ] + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" }, - "subscriptions_url": { - "type": "string", - "format": "uri" + { + "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" + ] + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "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" ] + } + ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "anyOf": [ + { + "type": "null" }, - "url": { - "type": "string", - "format": "uri" + { + "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" + ] } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] } + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "external_identifier": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "external_reference": { + "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" ], - "format": "uri" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "fix_reason": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "fixed_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "fixed_in": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "ghsa_id": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "id": { - "type": "integer" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "number": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "severity": { - "type": "string" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "state": { + "repos_url": { "type": "string", - "enum": [ - "auto_dismissed", - "open" + "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" + ] }, "enterprise": { "title": "Enterprise", @@ -1667571,8 +1679091,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1667586,21 +1679105,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1667622,7 +1679142,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1667665,185 +1679185,1082 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "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" ] - }, - "url": { - "type": "string", - "format": "uri" } - } + ] }, - "external_identifier": { - "type": "string" + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." }, - "external_reference": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { "type": [ "string", "null" ], - "format": "uri" + "description": "The provider of the secret that was detected." }, - "fix_reason": { - "type": "string" + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." }, - "fixed_at": { + "validity": { "type": "string", - "format": "date-time" + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "fixed_in": { - "type": "string" + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." }, - "ghsa_id": { - "type": "string" + "push_protection_bypassed_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" + ] + } + ] }, - "id": { - "type": "integer" + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, - "node_id": { - "type": "string" + "push_protection_bypass_request_reviewer": { + "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" + ] + } + ] }, - "number": { - "type": "integer" + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "severity": { - "type": "string" + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "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" + ] + } ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1669763,8 +1682180,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1669778,21 +1682194,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-assigned": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was assigned.", - "operationId": "secret-scanning-alert/assigned", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1669814,7 +1682231,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "secret_scanning_alert_location", "schema": { "type": "string" } @@ -1669857,13 +1682274,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert assigned event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "assigned" + "created" ] }, "alert": { @@ -1670911,291 +1683328,475 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", + "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": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "The ID of the installation.", "type": "integer", - "format": "int64", "examples": [ 1 ] }, "node_id": { + "description": "The global node ID of the installation.", "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" + "MDQ6VXNlcjU4MzIzMQ==" ] } }, "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" + "node_id" ] }, - "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).\"", + "location": { "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": { "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" ], - "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", + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", "examples": [ - 1 + "commit" ] }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "examples": [ + "/example/secrets.txt" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": [ + "/example/Home.md" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082" + ] + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussion-4566270" + ] + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + ] + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } ] } - }, - "required": [ - "id", - "node_id" - ] + } }, "organization": { "title": "Organization Simple", @@ -1672996,10 +1685597,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1673011,8 +1685787,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1673021,11 +1685798,11 @@ } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-metadata-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "description": "Metadata was created for a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1673092,13 +1685869,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "secret_scanning_alert metadata created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_created" ] }, "alert": { @@ -1673747,405 +1686524,427 @@ } ] }, - "push_protection_bypass_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when reviewing a push protection bypass." - }, - "push_protection_bypass_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when requesting a push protection bypass." - }, - "push_protection_bypass_request_html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was publicly leaked." - }, - "multi_repo": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or business." - }, - "assigned_to": { - "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" - ] - } + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "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" + ] + } + ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." }, - "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" - ] - } - ] - }, - "closure_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request author." - }, - "closure_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request reviewer." - }, - "closure_request_reviewer": { - "anyOf": [ - { - "type": "null" + "value": { + "type": "string", + "description": "The metadata value." + } }, - { - "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": [ + "key", + "value" + ] + } } } }, @@ -1676077,7 +1688876,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -1676088,13 +1688886,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-metadata-removed": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "Metadata was removed from a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1676116,7 +1688914,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert_location", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1676159,13 +1688957,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert metadata removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_removed" ] }, "alert": { @@ -1677213,453 +1690011,145 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, - "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).\"", + "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": "The ID of the installation.", + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { - "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "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" + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, - "location": { + "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": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "commit" + 1 ] }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/example/secrets.txt" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL to get the associated commit resource.", - "examples": [ - "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "examples": [ - "/example/Home.md" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1" - ] - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1" - ] - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" - ] - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082" - ] - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussion-4566270" - ] - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846" - ] - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846" - ] - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" - ] - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request review where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" - ] - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request review comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" ] } - } + }, + "required": [ + "id", + "node_id" + ] }, "organization": { "title": "Organization Simple", @@ -1679460,185 +1691950,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1679649,10 +1691964,8 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1680786,6 +1693099,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1683665,194 +1696000,216 @@ } ] }, - "closure_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request author." - }, - "closure_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request reviewer." - }, - "closure_request_reviewer": { - "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" - ] - } + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." }, - "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" - ] - } - ] + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1686920,6 +1699277,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1689987,6 +1702366,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1693222,6 +1705623,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 02ef7d0b39..a3903cb70c 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 @@ -1131,7 +1131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &668 + - &670 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -14697,7 +14697,7 @@ paths: properties: action: type: string - discussion: &761 + discussion: &763 title: Discussion description: A Discussion in a repository. type: object @@ -15483,7 +15483,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &679 + sub_issues_summary: &681 title: Sub-issues Summary type: object properties: @@ -15613,7 +15613,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &680 + issue_dependencies_summary: &682 title: Issue Dependencies Summary type: object properties: @@ -17206,7 +17206,7 @@ paths: url: type: string format: uri - user: &688 + user: &690 title: Public User description: Public User type: object @@ -23246,7 +23246,7 @@ paths: parameters: - *74 - *116 - - &739 + - &741 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -23358,7 +23358,7 @@ paths: - *116 - *117 - *118 - - &740 + - &742 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -23366,7 +23366,7 @@ paths: schema: type: string - *121 - - &741 + - &743 name: sku description: The SKU to query for usage. in: query @@ -31078,12 +31078,12 @@ paths: required: - subject_digests examples: - default: &720 + default: &722 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &721 + withPredicateType: &723 value: subject_digests: - sha256:abc123 @@ -31142,7 +31142,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &722 + default: &724 value: attestations_subject_digests: - sha256:abc: @@ -43421,7 +43421,7 @@ paths: parameters: - *74 - *257 - - &703 + - &705 name: repo_name description: repo_name parameter in: path @@ -44500,7 +44500,7 @@ paths: - nuget - container - *74 - - &704 + - &706 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -44541,7 +44541,7 @@ paths: default: *263 '403': *27 '401': *23 - '400': &706 + '400': &708 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -46672,7 +46672,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &789 + - &791 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -47642,7 +47642,7 @@ paths: - updated_at - project_url examples: - default: &726 + default: &728 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47819,7 +47819,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &727 + items: &729 type: object properties: name: @@ -47856,7 +47856,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &728 + iteration_configuration: &730 type: object description: The configuration for iteration fields. properties: @@ -47906,7 +47906,7 @@ paths: value: name: Due date data_type: date - single_select_field: &729 + single_select_field: &731 summary: Create a single select field value: name: Priority @@ -47933,7 +47933,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &730 + iteration_field: &732 summary: Create an iteration field value: name: Sprint @@ -47959,7 +47959,7 @@ paths: application/json: schema: *283 examples: - text_field: &731 + text_field: &733 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -47968,7 +47968,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &732 + number_field: &734 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -47977,7 +47977,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &733 + date_field: &735 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -47986,7 +47986,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &734 + single_select_field: &736 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -48020,7 +48020,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &735 + iteration_field: &737 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -48066,7 +48066,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *280 - - &736 + - &738 name: field_id description: The unique identifier of the field. in: path @@ -48081,7 +48081,7 @@ paths: application/json: schema: *283 examples: - default: &737 + default: &739 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -49292,7 +49292,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &717 + schema: &719 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -49475,7 +49475,7 @@ paths: parameters: - *280 - *74 - - &738 + - &740 name: view_number description: The number that identifies the project view. in: path @@ -52068,6 +52068,43 @@ paths: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + title: DismissalRestriction + description: Specify people, teams, or apps allowed + to dismiss pull request reviews. + type: object + properties: + allowed_actors: + type: array + description: Specify people, teams, or apps + allowed to dismiss pull request reviews. + items: + title: Actor + description: An actor allowed to dismiss pull + request reviews + type: object + properties: + id: + type: integer + description: ID of the actor that can + dismiss reviews. + type: + type: string + description: The type of the actor + enum: + - User + - Team + - IntegrationInstallation + - RepositoryRole + required: + - id + - type + enabled: + type: boolean + description: Whether to restrict review dismissal + to specific actors. + required: + - enabled require_code_owner_review: type: boolean description: Require an approving review in pull @@ -53670,6 +53707,29 @@ paths: required: false schema: type: boolean + - &646 + name: included_metadata + in: query + description: |- + A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the + specified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`, + `owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`, + `organization-id`, `last-used-date`, and `has-organization-access`. + required: false + schema: + type: string + - &647 + name: owner_email_hash + in: query + description: |- + Filters alerts to only those whose attached `owner_email` metadata field matches the + provided value. The value must be the lowercase hex-encoded SHA-256 hash of the email + address to match (for example, the SHA-256 of `user@example.com`). Only alerts that + have an `owner_email` metadata value whose SHA-256 hash equals this parameter are + returned. + required: false + schema: + type: string responses: '200': description: Response @@ -53693,14 +53753,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &646 + state: &648 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &647 + resolution: &649 type: - string - 'null' @@ -53819,14 +53879,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &648 + - &650 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &650 + - &652 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -53890,7 +53950,7 @@ paths: - blob_url - commit_sha - commit_url - - &651 + - &653 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -53951,7 +54011,7 @@ paths: - page_url - commit_sha - commit_url - - &652 + - &654 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -53973,7 +54033,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &653 + - &655 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -53995,7 +54055,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &654 + - &656 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -54017,7 +54077,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &655 + - &657 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -54032,7 +54092,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &656 + - &658 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -54047,7 +54107,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &657 + - &659 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -54062,7 +54122,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &658 + - &660 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -54084,7 +54144,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &659 + - &661 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -54106,7 +54166,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &660 + - &662 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -54128,7 +54188,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &661 + - &663 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -54150,7 +54210,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &662 + - &664 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -54671,7 +54731,7 @@ paths: application/json: schema: type: array - items: &666 + items: &668 description: A repository security advisory. type: object properties: @@ -55022,7 +55082,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &667 + default: &669 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -56973,7 +57033,7 @@ paths: application/json: schema: type: array - items: &682 + items: &684 title: Team Member description: A user that is a member of a team, including their role on the team and whether the membership is inherited from @@ -57116,7 +57176,7 @@ paths: - type - url examples: - default: &683 + default: &685 value: - login: octocat id: 1 @@ -57203,7 +57263,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &684 + response-if-user-is-a-team-maintainer: &686 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -57268,7 +57328,7 @@ paths: application/json: schema: *336 examples: - response-if-users-membership-with-team-is-now-pending: &685 + response-if-users-membership-with-team-is-now-pending: &687 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -57382,7 +57442,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &686 + schema: &688 title: Team Repository description: A team's access to a repository. type: object @@ -58196,7 +58256,7 @@ paths: type: array items: *200 examples: - response-if-child-teams-exist: &687 + response-if-child-teams-exist: &689 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -70351,7 +70411,7 @@ paths: check. type: array items: *85 - deployment: &750 + deployment: &752 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -76088,7 +76148,7 @@ paths: type: array items: *459 examples: - default: &693 + default: &695 value: total_count: 2 machines: @@ -79265,7 +79325,7 @@ paths: application/json: schema: type: array - items: &671 + items: &673 title: Status description: The status of a commit. type: object @@ -80921,7 +80981,7 @@ paths: items: type: object properties: - placeholder_id: &663 + placeholder_id: &665 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -87126,7 +87186,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &781 + last_response: &783 title: Hook Response type: object properties: @@ -88195,7 +88255,7 @@ paths: parameters: - *337 - *338 - - &715 + - &717 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -88780,7 +88840,7 @@ paths: type: array items: *534 examples: - default: &708 + default: &710 value: - id: 1 repository: @@ -103985,6 +104045,8 @@ paths: - *643 - *644 - *645 + - *646 + - *647 responses: '200': description: Response @@ -103992,7 +104054,7 @@ paths: application/json: schema: type: array - items: &649 + items: type: object properties: number: *180 @@ -104008,8 +104070,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *646 - resolution: *647 + state: *648 + resolution: *649 resolved_at: type: - string @@ -104115,7 +104177,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *648 + - *650 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -104283,7 +104345,168 @@ paths: description: Response content: application/json: - schema: *649 + schema: &651 + type: object + properties: + number: *180 + created_at: *181 + updated_at: + anyOf: + - type: 'null' + - *182 + url: *183 + html_url: *184 + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: *648 + resolution: *649 + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - *4 + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + provider: + type: + - string + - 'null' + description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret + that was detected. Use this value for filtering by provider + with the `providers` or `exclude_providers` parameters. + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected + secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - *4 + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO + 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection + bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the detected secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple + repositories under the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert + is base64 encoded + first_location_detected: + anyOf: + - type: 'null' + - *650 + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token + in the alert was detected in more than one location. + assigned_to: + anyOf: + - type: 'null' + - *4 + closure_request_comment: + type: + - string + - 'null' + description: An optional comment from the closure request author. + closure_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment from the closure request reviewer. + closure_request_reviewer: + anyOf: + - type: 'null' + - *4 + metadata: &802 + type: array + description: A list of metadata key/value pairs associated with + the secret scanning alert. + readOnly: true + items: + type: object + properties: + key: + type: string + description: The metadata key. + value: + type: string + description: The metadata value. + required: + - key + - value examples: default: value: @@ -104310,6 +104533,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com '304': *35 '404': description: Repository is public, or secret scanning is disabled for the @@ -104347,8 +104573,8 @@ paths: schema: type: object properties: - state: *646 - resolution: *647 + state: *648 + resolution: *649 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -104396,7 +104622,7 @@ paths: description: Response content: application/json: - schema: *649 + schema: *651 examples: default: value: @@ -104441,6 +104667,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -104508,7 +104737,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &801 + items: &804 type: object properties: type: @@ -104535,8 +104764,6 @@ paths: - commit details: oneOf: - - *650 - - *651 - *652 - *653 - *654 @@ -104548,6 +104775,8 @@ paths: - *660 - *661 - *662 + - *663 + - *664 examples: default: value: @@ -104642,14 +104871,14 @@ paths: schema: type: object properties: - reason: &664 + reason: &666 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *663 + placeholder_id: *665 required: - reason - placeholder_id @@ -104666,7 +104895,7 @@ paths: schema: type: object properties: - reason: *664 + reason: *666 expire_at: type: - string @@ -104729,7 +104958,7 @@ paths: properties: incremental_scans: type: array - items: &665 + items: &667 description: Information on a single scan performed by secret scanning on the repository type: object @@ -104762,15 +104991,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *665 + items: *667 backfill_scans: type: array - items: *665 + items: *667 custom_pattern_backfill_scans: type: array items: allOf: - - *665 + - *667 - type: object properties: pattern_name: @@ -104783,7 +105012,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *665 + items: *667 examples: default: value: @@ -104893,9 +105122,9 @@ paths: application/json: schema: type: array - items: *666 + items: *668 examples: - default: *667 + default: *669 '400': *14 '404': *6 x-github: @@ -105089,9 +105318,9 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: &669 + default: &671 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -105444,7 +105673,7 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: default: value: @@ -105599,15 +105828,15 @@ paths: parameters: - *337 - *338 - - *668 + - *670 responses: '200': description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: *669 + default: *671 '403': *27 '404': *6 x-github: @@ -105633,7 +105862,7 @@ paths: parameters: - *337 - *338 - - *668 + - *670 requestBody: required: true content: @@ -105804,10 +106033,10 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: *669 - add_credit: *669 + default: *671 + add_credit: *671 '403': *27 '404': *6 '422': @@ -105847,7 +106076,7 @@ paths: parameters: - *337 - *338 - - *668 + - *670 responses: '202': *37 '400': *14 @@ -105876,7 +106105,7 @@ paths: parameters: - *337 - *338 - - *668 + - *670 responses: '202': description: Response @@ -106017,7 +106246,7 @@ paths: application/json: schema: type: array - items: &670 + items: &672 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -106390,7 +106619,7 @@ paths: application/json: schema: type: array - items: *670 + items: *672 examples: default: value: @@ -106480,7 +106709,7 @@ paths: description: Response content: application/json: - schema: *671 + schema: *673 examples: default: value: @@ -106574,7 +106803,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &672 + schema: &674 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -106674,7 +106903,7 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: default: value: @@ -106884,7 +107113,7 @@ paths: description: Response content: application/json: - schema: &673 + schema: &675 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -106896,7 +107125,7 @@ paths: required: - names examples: - default: &674 + default: &676 value: names: - octocat @@ -106951,9 +107180,9 @@ paths: description: Response content: application/json: - schema: *673 + schema: *675 examples: - default: *674 + default: *676 '404': *6 '422': *7 x-github: @@ -106976,7 +107205,7 @@ paths: parameters: - *337 - *338 - - &675 + - &677 name: per description: The time frame to display results for. in: query @@ -107007,7 +107236,7 @@ paths: - 128 clones: type: array - items: &676 + items: &678 title: Traffic type: object properties: @@ -107255,7 +107484,7 @@ paths: parameters: - *337 - *338 - - *675 + - *677 responses: '200': description: Response @@ -107276,7 +107505,7 @@ paths: - 3782 views: type: array - items: *676 + items: *678 required: - uniques - count @@ -108055,7 +108284,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &677 + text_matches: &679 title: Search Result Text Matches type: array items: @@ -108218,7 +108447,7 @@ paths: enum: - author-date - committer-date - - &678 + - &680 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -108338,7 +108567,7 @@ paths: type: number node_id: type: string - text_matches: *677 + text_matches: *679 required: - sha - node_id @@ -108530,7 +108759,7 @@ paths: - interactions - created - updated - - *678 + - *680 - *17 - *19 - name: advanced_search @@ -108644,8 +108873,8 @@ paths: type: - string - 'null' - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -108676,7 +108905,7 @@ paths: - string - 'null' format: date-time - text_matches: *677 + text_matches: *679 pull_request: type: object properties: @@ -108986,7 +109215,7 @@ paths: enum: - created - updated - - *678 + - *680 - *17 - *19 responses: @@ -109031,7 +109260,7 @@ paths: - 'null' score: type: number - text_matches: *677 + text_matches: *679 required: - id - node_id @@ -109116,7 +109345,7 @@ paths: - forks - help-wanted-issues - updated - - *678 + - *680 - *17 - *19 responses: @@ -109362,7 +109591,7 @@ paths: - admin - pull - push - text_matches: *677 + text_matches: *679 temp_clone_token: type: string allow_merge_commit: @@ -109670,7 +109899,7 @@ paths: - string - 'null' format: uri - text_matches: *677 + text_matches: *679 related: type: - array @@ -109863,7 +110092,7 @@ paths: - followers - repositories - joined - - *678 + - *680 - *17 - *19 responses: @@ -109973,7 +110202,7 @@ paths: type: - boolean - 'null' - text_matches: *677 + text_matches: *679 blog: type: - string @@ -110055,7 +110284,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &681 + - &683 name: team_id description: The unique identifier of the team. in: path @@ -110096,7 +110325,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *681 + - *683 requestBody: required: true content: @@ -110197,7 +110426,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *681 + - *683 responses: '204': description: Response @@ -110226,7 +110455,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -110266,7 +110495,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *681 + - *683 - name: role description: Filters members returned by their role in the team. in: query @@ -110287,9 +110516,9 @@ paths: application/json: schema: type: array - items: *682 + items: *684 examples: - default: *683 + default: *685 headers: Link: *66 '404': *6 @@ -110317,7 +110546,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -110354,7 +110583,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -110394,7 +110623,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -110431,7 +110660,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *681 + - *683 - *70 responses: '200': @@ -110440,7 +110669,7 @@ paths: application/json: schema: *336 examples: - response-if-user-is-a-team-maintainer: *684 + response-if-user-is-a-team-maintainer: *686 '404': *6 x-github: githubCloudOnly: false @@ -110473,7 +110702,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *681 + - *683 - *70 requestBody: required: false @@ -110501,7 +110730,7 @@ paths: application/json: schema: *336 examples: - response-if-users-membership-with-team-is-now-pending: *685 + response-if-users-membership-with-team-is-now-pending: *687 '403': description: Forbidden if team synchronization is set up '422': @@ -110535,7 +110764,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *681 + - *683 - *70 responses: '204': @@ -110563,7 +110792,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -110605,7 +110834,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *681 + - *683 - *337 - *338 responses: @@ -110613,7 +110842,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *686 + schema: *688 examples: alternative-response-with-extra-repository-information: value: @@ -110770,7 +110999,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *681 + - *683 - *337 - *338 requestBody: @@ -110822,7 +111051,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *681 + - *683 - *337 - *338 responses: @@ -110849,7 +111078,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -110861,7 +111090,7 @@ paths: type: array items: *200 examples: - response-if-child-teams-exist: *687 + response-if-child-teams-exist: *689 headers: Link: *66 '404': *6 @@ -110894,7 +111123,7 @@ paths: application/json: schema: oneOf: - - &689 + - &691 title: Private User description: Private User type: object @@ -111144,7 +111373,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *688 + - *690 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -111304,7 +111533,7 @@ paths: description: Response content: application/json: - schema: *689 + schema: *691 examples: default: value: @@ -111702,7 +111931,7 @@ paths: type: integer secrets: type: array - items: &690 + items: &692 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -111822,7 +112051,7 @@ paths: description: Response content: application/json: - schema: *690 + schema: *692 examples: default: value: @@ -112235,7 +112464,7 @@ paths: description: Response content: application/json: - schema: &691 + schema: &693 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -112288,7 +112517,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &692 + default: &694 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -112333,9 +112562,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: *692 + default: *694 '404': *6 x-github: githubCloudOnly: false @@ -112374,7 +112603,7 @@ paths: type: array items: *459 examples: - default: *693 + default: *695 '304': *35 '500': *53 '401': *23 @@ -113340,7 +113569,7 @@ paths: type: array items: *262 examples: - default: &705 + default: &707 value: - id: 197 name: hello_docker @@ -113441,7 +113670,7 @@ paths: application/json: schema: type: array - items: &694 + items: &696 title: Email description: Email type: object @@ -113511,9 +113740,9 @@ paths: application/json: schema: type: array - items: *694 + items: *696 examples: - default: &707 + default: &709 value: - email: octocat@github.com verified: true @@ -113590,7 +113819,7 @@ paths: application/json: schema: type: array - items: *694 + items: *696 examples: default: value: @@ -113848,7 +114077,7 @@ paths: application/json: schema: type: array - items: &695 + items: &697 title: GPG Key description: A unique encryption key type: object @@ -113993,7 +114222,7 @@ paths: - subkeys - revoked examples: - default: &724 + default: &726 value: - id: 3 name: Octocat's GPG Key @@ -114078,9 +114307,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: &696 + default: &698 value: id: 3 name: Octocat's GPG Key @@ -114137,7 +114366,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &697 + - &699 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -114149,9 +114378,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: *696 + default: *698 '404': *6 '304': *35 '403': *27 @@ -114174,7 +114403,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *697 + - *699 responses: '204': description: Response @@ -114641,7 +114870,7 @@ paths: application/json: schema: type: array - items: &698 + items: &700 title: Key description: Key type: object @@ -114744,9 +114973,9 @@ paths: description: Response content: application/json: - schema: *698 + schema: *700 examples: - default: &699 + default: &701 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -114785,9 +115014,9 @@ paths: description: Response content: application/json: - schema: *698 + schema: *700 examples: - default: *699 + default: *701 '404': *6 '304': *35 '403': *27 @@ -114843,7 +115072,7 @@ paths: application/json: schema: type: array - items: &700 + items: &702 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -114922,7 +115151,7 @@ paths: - account - plan examples: - default: &701 + default: &703 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -114984,9 +115213,9 @@ paths: application/json: schema: type: array - items: *700 + items: *702 examples: - default: *701 + default: *703 headers: Link: *66 '304': *35 @@ -115229,7 +115458,7 @@ paths: application/json: schema: *254 examples: - default: &702 + default: &704 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -115278,7 +115507,7 @@ paths: application/json: schema: *254 examples: - default: *702 + default: *704 '403': *27 '404': *6 '422': *15 @@ -116012,7 +116241,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *257 - - *703 + - *705 responses: '204': description: Response @@ -116145,7 +116374,7 @@ paths: - docker - nuget - container - - *704 + - *706 - *19 - *17 responses: @@ -116157,8 +116386,8 @@ paths: type: array items: *262 examples: - default: *705 - '400': *706 + default: *707 + '400': *708 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -116187,7 +116416,7 @@ paths: application/json: schema: *262 examples: - default: &725 + default: &727 value: id: 40201 name: octo-name @@ -116549,9 +116778,9 @@ paths: application/json: schema: type: array - items: *694 + items: *696 examples: - default: *707 + default: *709 headers: Link: *66 '304': *35 @@ -116664,7 +116893,7 @@ paths: type: array items: *78 examples: - default: &714 + default: &716 summary: Default response value: - id: 1296269 @@ -117030,7 +117259,7 @@ paths: type: array items: *534 examples: - default: *708 + default: *710 headers: Link: *66 '304': *35 @@ -117115,7 +117344,7 @@ paths: application/json: schema: type: array - items: &709 + items: &711 title: Social account description: Social media account type: object @@ -117132,7 +117361,7 @@ paths: - provider - url examples: - default: &710 + default: &712 value: - provider: twitter url: https://twitter.com/github @@ -117195,9 +117424,9 @@ paths: application/json: schema: type: array - items: *709 + items: *711 examples: - default: *710 + default: *712 '422': *15 '304': *35 '404': *6 @@ -117285,7 +117514,7 @@ paths: application/json: schema: type: array - items: &711 + items: &713 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -117305,7 +117534,7 @@ paths: - title - created_at examples: - default: &742 + default: &744 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -117370,9 +117599,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: &712 + default: &714 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -117402,7 +117631,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &713 + - &715 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -117414,9 +117643,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: *712 + default: *714 '404': *6 '304': *35 '403': *27 @@ -117439,7 +117668,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *713 + - *715 responses: '204': description: Response @@ -117468,7 +117697,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &743 + - &745 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -117493,11 +117722,11 @@ paths: type: array items: *78 examples: - default-response: *714 + default-response: *716 application/vnd.github.v3.star+json: schema: type: array - items: &744 + items: &746 title: Starred Repository description: Starred Repository type: object @@ -117866,10 +118095,10 @@ paths: application/json: schema: oneOf: - - *689 - - *688 + - *691 + - *690 examples: - default-response: &718 + default-response: &720 summary: Default response value: login: octocat @@ -117904,7 +118133,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &719 + response-with-git-hub-plan-information: &721 summary: Response with GitHub plan information value: login: octocat @@ -117961,7 +118190,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &716 + - &718 name: user_id description: The unique identifier of the user. in: path @@ -118027,7 +118256,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *715 + - *717 - *17 responses: '200': @@ -118062,7 +118291,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *716 + - *718 - *280 requestBody: required: true @@ -118137,7 +118366,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *717 + schema: *719 examples: table_view: summary: Response for creating a table view @@ -118189,11 +118418,11 @@ paths: application/json: schema: oneOf: - - *689 - - *688 + - *691 + - *690 examples: - default-response: *718 - response-with-git-hub-plan-information: *719 + default-response: *720 + response-with-git-hub-plan-information: *721 '404': *6 x-github: githubCloudOnly: false @@ -118243,8 +118472,8 @@ paths: required: - subject_digests examples: - default: *720 - withPredicateType: *721 + default: *722 + withPredicateType: *723 responses: '200': description: Response @@ -118298,7 +118527,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *722 + default: *724 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -118816,7 +119045,7 @@ paths: application/json: schema: *196 examples: - default: &723 + default: &725 summary: Example response for a user copilot space value: id: 42 @@ -118917,7 +119146,7 @@ paths: application/json: schema: *196 examples: - default: *723 + default: *725 '403': *27 '404': *6 x-github: @@ -119043,7 +119272,7 @@ paths: application/json: schema: *196 examples: - default: *723 + default: *725 '403': *27 '404': *6 '422': *15 @@ -119811,7 +120040,7 @@ paths: type: array items: *262 examples: - default: *705 + default: *707 '403': *27 '401': *23 x-github: @@ -120195,9 +120424,9 @@ paths: application/json: schema: type: array - items: *695 + items: *697 examples: - default: *724 + default: *726 headers: Link: *66 x-github: @@ -120426,7 +120655,7 @@ paths: - docker - nuget - container - - *704 + - *706 - *70 - *19 - *17 @@ -120439,10 +120668,10 @@ paths: type: array items: *262 examples: - default: *705 + default: *707 '403': *27 '401': *23 - '400': *706 + '400': *708 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120472,7 +120701,7 @@ paths: application/json: schema: *262 examples: - default: *725 + default: *727 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120821,7 +121050,7 @@ paths: type: array items: *283 examples: - default: *726 + default: *728 headers: Link: *66 '304': *35 @@ -120881,7 +121110,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *727 + items: *729 required: - name - data_type @@ -120897,7 +121126,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *728 + iteration_configuration: *730 required: - name - data_type @@ -120919,8 +121148,8 @@ paths: value: name: Due date data_type: date - single_select_field: *729 - iteration_field: *730 + single_select_field: *731 + iteration_field: *732 responses: '201': description: Response @@ -120928,11 +121157,11 @@ paths: application/json: schema: *283 examples: - text_field: *731 - number_field: *732 - date_field: *733 - single_select_field: *734 - iteration_field: *735 + text_field: *733 + number_field: *734 + date_field: *735 + single_select_field: *736 + iteration_field: *737 '304': *35 '403': *27 '401': *23 @@ -120954,7 +121183,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *280 - - *736 + - *738 - *70 responses: '200': @@ -120963,7 +121192,7 @@ paths: application/json: schema: *283 examples: - default: *737 + default: *739 headers: Link: *66 '304': *35 @@ -121320,7 +121549,7 @@ paths: parameters: - *280 - *70 - - *738 + - *740 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -121859,7 +122088,7 @@ paths: parameters: - *70 - *116 - - *739 + - *741 - *118 responses: '200': @@ -121958,9 +122187,9 @@ paths: - *116 - *117 - *118 - - *740 + - *742 - *121 - - *741 + - *743 responses: '200': description: Response when getting a billing usage summary @@ -122094,9 +122323,9 @@ paths: application/json: schema: type: array - items: *709 + items: *711 examples: - default: *710 + default: *712 headers: Link: *66 x-github: @@ -122126,9 +122355,9 @@ paths: application/json: schema: type: array - items: *711 + items: *713 examples: - default: *742 + default: *744 headers: Link: *66 x-github: @@ -122153,7 +122382,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *70 - - *743 + - *745 - *60 - *17 - *19 @@ -122165,11 +122394,11 @@ paths: schema: anyOf: - type: array - items: *744 + items: *746 - type: array items: *78 examples: - default-response: *714 + default-response: *716 headers: Link: *66 x-github: @@ -122329,7 +122558,7 @@ webhooks: type: string enum: - disabled - enterprise: &745 + enterprise: &747 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -122398,7 +122627,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &746 + installation: &748 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -122419,7 +122648,7 @@ webhooks: required: - id - node_id - organization: &747 + organization: &749 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -122492,7 +122721,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &748 + repository: &750 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -123432,10 +123661,10 @@ webhooks: type: string enum: - enabled - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -123511,11 +123740,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - rule: &749 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + rule: &751 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -123738,11 +123967,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - rule: *749 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + rule: *751 sender: *4 required: - action @@ -123930,11 +124159,11 @@ webhooks: - everyone required: - from - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - rule: *749 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + rule: *751 sender: *4 required: - action @@ -124018,7 +124247,7 @@ webhooks: type: string enum: - completed - check_run: &751 + check_run: &753 title: CheckRun description: A check performed on the code of a given code change type: object @@ -124128,7 +124357,7 @@ webhooks: - examples: - neutral - deployment: *750 + deployment: *752 details_url: type: string examples: @@ -124226,10 +124455,10 @@ webhooks: - output - app - pull_requests - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 sender: *4 required: - check_run @@ -124620,11 +124849,11 @@ webhooks: type: string enum: - created - check_run: *751 - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + check_run: *753 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 sender: *4 required: - check_run @@ -125018,11 +125247,11 @@ webhooks: type: string enum: - requested_action - check_run: *751 - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + check_run: *753 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 requested_action: description: The action requested by the user. type: object @@ -125425,11 +125654,11 @@ webhooks: type: string enum: - rerequested - check_run: *751 - installation: *746 - enterprise: *745 - organization: *747 - repository: *748 + check_run: *753 + installation: *748 + enterprise: *747 + organization: *749 + repository: *750 sender: *4 required: - check_run @@ -126414,10 +126643,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -127131,10 +127360,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -127842,10 +128071,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -128166,20 +128395,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &752 + commit_oid: &754 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *745 - installation: *746 - organization: *747 - ref: &753 + enterprise: *747 + installation: *748 + organization: *749 + ref: &755 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *748 + repository: *750 sender: *4 required: - action @@ -128587,12 +128816,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -128875,12 +129104,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -129226,12 +129455,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -129521,9 +129750,9 @@ webhooks: type: - string - 'null' - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -129531,7 +129760,7 @@ webhooks: type: - string - 'null' - repository: *748 + repository: *750 sender: *4 required: - action @@ -129777,12 +130006,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *752 - enterprise: *745 - installation: *746 - organization: *747 - ref: *753 - repository: *748 + commit_oid: *754 + enterprise: *747 + installation: *748 + organization: *749 + ref: *755 + repository: *750 sender: *4 required: - action @@ -130103,10 +130332,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -130366,10 +130595,10 @@ webhooks: - updated_at - author_association - body - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -130450,18 +130679,18 @@ webhooks: type: - string - 'null' - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *747 - pusher_type: &754 + organization: *749 + pusher_type: &756 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &755 + ref: &757 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -130471,7 +130700,7 @@ webhooks: enum: - tag - branch - repository: *748 + repository: *750 sender: *4 required: - ref @@ -130554,9 +130783,9 @@ webhooks: enum: - created definition: *291 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -130641,9 +130870,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -130721,9 +130950,9 @@ webhooks: enum: - promote_to_enterprise definition: *291 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -130801,9 +131030,9 @@ webhooks: enum: - updated definition: *291 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -130880,10 +131109,10 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - repository: *748 - organization: *747 + enterprise: *747 + installation: *748 + repository: *750 + organization: *749 sender: *4 new_property_values: type: array @@ -130968,18 +131197,18 @@ webhooks: title: delete event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - pusher_type: *754 - ref: *755 + enterprise: *747 + installation: *748 + organization: *749 + pusher_type: *756 + ref: *757 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *748 + repository: *750 sender: *4 required: - ref @@ -131060,10 +131289,10 @@ webhooks: enum: - assignees_changed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -131144,10 +131373,10 @@ webhooks: enum: - auto_dismissed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -131229,10 +131458,10 @@ webhooks: enum: - auto_reopened alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -131314,10 +131543,10 @@ webhooks: enum: - created alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -131397,10 +131626,10 @@ webhooks: enum: - dismissed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -131480,10 +131709,10 @@ webhooks: enum: - fixed alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -131564,10 +131793,10 @@ webhooks: enum: - reintroduced alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -131647,10 +131876,10 @@ webhooks: enum: - reopened alert: *490 - installation: *746 - organization: *747 - enterprise: *745 - repository: *748 + installation: *748 + organization: *749 + enterprise: *747 + repository: *750 sender: *4 required: - action @@ -131727,9 +131956,9 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - key: &756 + enterprise: *747 + installation: *748 + key: &758 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -131767,8 +131996,8 @@ webhooks: - verified - created_at - read_only - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -131845,11 +132074,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - key: *756 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + key: *758 + organization: *749 + repository: *750 sender: *4 required: - action @@ -132416,12 +132645,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: &760 + workflow: &762 title: Workflow type: - object @@ -133176,9 +133405,9 @@ webhooks: pull_requests: type: array items: *596 - repository: *748 - organization: *747 - installation: *746 + repository: *750 + organization: *749 + installation: *748 sender: *4 responses: '200': @@ -133249,7 +133478,7 @@ webhooks: type: string enum: - approved - approver: &757 + approver: &759 type: object properties: avatar_url: @@ -133292,11 +133521,11 @@ webhooks: type: string comment: type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - reviewers: &758 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + reviewers: &760 type: array items: type: object @@ -133377,7 +133606,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &759 + workflow_job_run: &761 type: object properties: conclusion: @@ -134123,18 +134352,18 @@ webhooks: type: string enum: - rejected - approver: *757 + approver: *759 comment: type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - reviewers: *758 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + reviewers: *760 sender: *4 since: type: string - workflow_job_run: *759 + workflow_job_run: *761 workflow_job_runs: type: array items: @@ -134851,13 +135080,13 @@ webhooks: type: string enum: - requested - enterprise: *745 + enterprise: *747 environment: type: string - installation: *746 - organization: *747 - repository: *748 - requestor: &765 + installation: *748 + organization: *749 + repository: *750 + requestor: &767 title: User type: - object @@ -136790,12 +137019,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Deployment Workflow Run type: @@ -137486,7 +137715,7 @@ webhooks: type: string enum: - answered - answer: &763 + answer: &765 type: object properties: author_association: @@ -137646,11 +137875,11 @@ webhooks: - created_at - updated_at - body - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137777,11 +138006,11 @@ webhooks: - from required: - category - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137864,11 +138093,11 @@ webhooks: type: string enum: - closed - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -137950,7 +138179,7 @@ webhooks: type: string enum: - created - comment: &762 + comment: &764 type: object properties: author_association: @@ -138110,11 +138339,11 @@ webhooks: - updated_at - body - reactions - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138197,12 +138426,12 @@ webhooks: type: string enum: - deleted - comment: *762 - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + comment: *764 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138297,12 +138526,12 @@ webhooks: - from required: - body - comment: *762 - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + comment: *764 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138386,11 +138615,11 @@ webhooks: type: string enum: - created - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138472,11 +138701,11 @@ webhooks: type: string enum: - deleted - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138576,11 +138805,11 @@ webhooks: type: string required: - from - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138662,10 +138891,10 @@ webhooks: type: string enum: - labeled - discussion: *761 - enterprise: *745 - installation: *746 - label: &764 + discussion: *763 + enterprise: *747 + installation: *748 + label: &766 title: Label type: object properties: @@ -138698,8 +138927,8 @@ webhooks: - color - default - description - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138782,11 +139011,11 @@ webhooks: type: string enum: - locked - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138868,11 +139097,11 @@ webhooks: type: string enum: - pinned - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -138954,11 +139183,11 @@ webhooks: type: string enum: - reopened - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -139043,16 +139272,16 @@ webhooks: changes: type: object properties: - new_discussion: *761 - new_repository: *748 + new_discussion: *763 + new_repository: *750 required: - new_discussion - new_repository - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -139135,10 +139364,10 @@ webhooks: type: string enum: - unanswered - discussion: *761 - old_answer: *763 - organization: *747 - repository: *748 + discussion: *763 + old_answer: *765 + organization: *749 + repository: *750 sender: *4 required: - action @@ -139220,12 +139449,12 @@ webhooks: type: string enum: - unlabeled - discussion: *761 - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -139308,11 +139537,11 @@ webhooks: type: string enum: - unlocked - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -139394,11 +139623,11 @@ webhooks: type: string enum: - unpinned - discussion: *761 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + discussion: *763 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -139471,7 +139700,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *745 + enterprise: *747 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -140149,9 +140378,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - forkee @@ -140297,9 +140526,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pages: description: The pages that were updated. type: array @@ -140337,7 +140566,7 @@ webhooks: - action - sha - html_url - repository: *748 + repository: *750 sender: *4 required: - pages @@ -140413,10 +140642,10 @@ webhooks: type: string enum: - created - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: &766 + organization: *749 + repositories: &768 description: An array of repository objects that the installation can access. type: array @@ -140442,8 +140671,8 @@ webhooks: - name - full_name - private - repository: *748 - requester: *765 + repository: *750 + requester: *767 sender: *4 required: - action @@ -140518,11 +140747,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -140599,11 +140828,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -140680,10 +140909,10 @@ webhooks: type: string enum: - added - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories_added: &767 + organization: *749 + repositories_added: &769 description: An array of repository objects, which were added to the installation. type: array @@ -140729,15 +140958,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *748 - repository_selection: &768 + repository: *750 + repository_selection: &770 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *765 + requester: *767 sender: *4 required: - action @@ -140816,10 +141045,10 @@ webhooks: type: string enum: - removed - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories_added: *767 + organization: *749 + repositories_added: *769 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -140846,9 +141075,9 @@ webhooks: - name - full_name - private - repository: *748 - repository_selection: *768 - requester: *765 + repository: *750 + repository_selection: *770 + requester: *767 sender: *4 required: - action @@ -140927,11 +141156,11 @@ webhooks: type: string enum: - suspend - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -141113,10 +141342,10 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 target_type: type: string @@ -141195,11 +141424,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *745 + enterprise: *747 installation: *20 - organization: *747 - repositories: *766 - repository: *748 + organization: *749 + repositories: *768 + repository: *750 requester: type: - 'null' @@ -141455,8 +141684,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -142268,8 +142497,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142630,8 +142859,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -142711,7 +142940,7 @@ webhooks: type: string enum: - deleted - comment: &769 + comment: &771 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -142886,8 +143115,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -143695,8 +143924,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144059,8 +144288,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -144140,7 +144369,7 @@ webhooks: type: string enum: - edited - changes: &793 + changes: &795 description: The changes to the comment. type: object properties: @@ -144152,9 +144381,9 @@ webhooks: type: string required: - from - comment: *769 - enterprise: *745 - installation: *746 + comment: *771 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -144965,8 +145194,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145327,8 +145556,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -145409,9 +145638,9 @@ webhooks: type: string enum: - pinned - comment: *769 - enterprise: *745 - installation: *746 + comment: *771 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -146224,8 +146453,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146588,8 +146817,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -146669,9 +146898,9 @@ webhooks: type: string enum: - unpinned - comment: *769 - enterprise: *745 - installation: *746 + comment: *771 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -147484,8 +147713,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147848,8 +148077,8 @@ webhooks: - state - locked - assignee - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -147938,9 +148167,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -148029,9 +148258,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -148119,9 +148348,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -148210,9 +148439,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -148292,10 +148521,10 @@ webhooks: type: string enum: - assigned - assignee: *765 - enterprise: *745 - installation: *746 - issue: &770 + assignee: *767 + enterprise: *747 + installation: *748 + issue: &772 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -149106,8 +149335,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -149230,8 +149459,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -149311,8 +149540,8 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -150128,8 +150357,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -150395,8 +150624,8 @@ webhooks: required: - state - closed_at - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -150475,8 +150704,8 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151283,8 +151512,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -151406,8 +151635,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -151486,8 +151715,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152317,8 +152546,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -152419,7 +152648,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &771 + milestone: &773 title: Milestone description: A collection of related issues and pull requests. type: object @@ -152562,8 +152791,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -152662,8 +152891,8 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153474,8 +153703,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -153598,9 +153827,9 @@ webhooks: - active_lock_reason - body - reactions - label: *764 - organization: *747 - repository: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -153680,9 +153909,9 @@ webhooks: type: string enum: - field_added - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 issue_field: type: object description: The issue field whose value was set or updated on the @@ -153848,8 +154077,8 @@ webhooks: - id required: - from - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -153929,9 +154158,9 @@ webhooks: type: string enum: - field_removed - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -154018,8 +154247,8 @@ webhooks: - 'null' required: - id - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -154099,8 +154328,8 @@ webhooks: type: string enum: - labeled - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -154910,8 +155139,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -155034,9 +155263,9 @@ webhooks: - active_lock_reason - body - reactions - label: *764 - organization: *747 - repository: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -155116,8 +155345,8 @@ webhooks: type: string enum: - locked - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -155952,8 +156181,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -156053,8 +156282,8 @@ webhooks: format: uri user_view_type: type: string - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -156133,8 +156362,8 @@ webhooks: type: string enum: - milestoned - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -156963,8 +157192,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -157064,9 +157293,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *771 - organization: *747 - repository: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -157953,8 +158182,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -158549,8 +158778,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -159357,8 +159586,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -159484,8 +159713,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -159565,9 +159794,9 @@ webhooks: type: string enum: - pinned - enterprise: *745 - installation: *746 - issue: &772 + enterprise: *747 + installation: *748 + issue: &774 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -160372,8 +160601,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -160495,8 +160724,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -160575,8 +160804,8 @@ webhooks: type: string enum: - reopened - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -161409,8 +161638,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -161511,8 +161740,8 @@ webhooks: user_view_type: type: string type: *245 - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -162400,8 +162629,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -163014,11 +163243,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *745 - installation: *746 - issue: *772 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *774 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163098,12 +163327,12 @@ webhooks: type: string enum: - typed - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 type: *245 - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163184,7 +163413,7 @@ webhooks: type: string enum: - unassigned - assignee: &796 + assignee: &798 title: User type: - object @@ -163256,11 +163485,11 @@ webhooks: required: - login - id - enterprise: *745 - installation: *746 - issue: *770 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *772 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163339,12 +163568,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *745 - installation: *746 - issue: *770 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *772 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -163424,8 +163653,8 @@ webhooks: type: string enum: - unlocked - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -164258,8 +164487,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array items: *547 @@ -164359,8 +164588,8 @@ webhooks: format: uri user_view_type: type: string - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -164440,11 +164669,11 @@ webhooks: type: string enum: - unpinned - enterprise: *745 - installation: *746 - issue: *772 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + issue: *774 + organization: *749 + repository: *750 sender: *4 required: - action @@ -164523,12 +164752,12 @@ webhooks: type: string enum: - untyped - enterprise: *745 - installation: *746 - issue: *770 + enterprise: *747 + installation: *748 + issue: *772 type: *245 - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -164608,11 +164837,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -164690,11 +164919,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -164804,11 +165033,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - label: *764 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + label: *766 + organization: *749 + repository: *750 sender: *4 required: - action @@ -164890,9 +165119,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: &773 + enterprise: *747 + installation: *748 + marketplace_purchase: &775 title: Marketplace Purchase type: object required: @@ -164980,8 +165209,8 @@ webhooks: type: integer unit_count: type: integer - organization: *747 - previous_marketplace_purchase: &774 + organization: *749 + previous_marketplace_purchase: &776 title: Marketplace Purchase type: object properties: @@ -165065,7 +165294,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *748 + repository: *750 sender: *4 required: - action @@ -165145,10 +165374,10 @@ webhooks: - changed effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: *773 - organization: *747 + enterprise: *747 + installation: *748 + marketplace_purchase: *775 + organization: *749 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -165236,7 +165465,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *748 + repository: *750 sender: *4 required: - action @@ -165318,10 +165547,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: *773 - organization: *747 + enterprise: *747 + installation: *748 + marketplace_purchase: *775 + organization: *749 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -165407,7 +165636,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *748 + repository: *750 sender: *4 required: - action @@ -165488,8 +165717,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 marketplace_purchase: title: Marketplace Purchase type: object @@ -165575,9 +165804,9 @@ webhooks: type: integer unit_count: type: integer - organization: *747 - previous_marketplace_purchase: *774 - repository: *748 + organization: *749 + previous_marketplace_purchase: *776 + repository: *750 sender: *4 required: - action @@ -165657,12 +165886,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *745 - installation: *746 - marketplace_purchase: *773 - organization: *747 - previous_marketplace_purchase: *774 - repository: *748 + enterprise: *747 + installation: *748 + marketplace_purchase: *775 + organization: *749 + previous_marketplace_purchase: *776 + repository: *750 sender: *4 required: - action @@ -165764,11 +165993,11 @@ webhooks: type: string required: - to - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 sender: *4 required: - action @@ -165870,11 +166099,11 @@ webhooks: type: - string - 'null' - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 sender: *4 required: - action @@ -165953,11 +166182,11 @@ webhooks: type: string enum: - removed - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166035,11 +166264,11 @@ webhooks: type: string enum: - added - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 scope: description: The scope of the membership. Currently, can only be `team`. @@ -166117,7 +166346,7 @@ webhooks: required: - login - id - team: &775 + team: &777 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -166347,11 +166576,11 @@ webhooks: type: string enum: - removed - enterprise: *745 - installation: *746 - member: *765 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + member: *767 + organization: *749 + repository: *750 scope: description: The scope of the membership. Currently, can only be `team`. @@ -166430,7 +166659,7 @@ webhooks: required: - login - id - team: *775 + team: *777 required: - action - scope @@ -166512,8 +166741,8 @@ webhooks: type: string enum: - checks_requested - installation: *746 - merge_group: &776 + installation: *748 + merge_group: &778 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -166539,8 +166768,8 @@ webhooks: - base_sha - base_ref - head_commit - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166626,10 +166855,10 @@ webhooks: - merged - invalidated - dequeued - installation: *746 - merge_group: *776 - organization: *747 - repository: *748 + installation: *748 + merge_group: *778 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166702,7 +166931,7 @@ webhooks: type: string enum: - deleted - enterprise: *745 + enterprise: *747 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -166811,12 +167040,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *746 - organization: *747 + installation: *748 + organization: *749 repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -166896,11 +167125,11 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 - milestone: *771 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -166979,9 +167208,9 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - milestone: &777 + enterprise: *747 + installation: *748 + milestone: &779 title: Milestone description: A collection of related issues and pull requests. type: object @@ -167123,8 +167352,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -167203,11 +167432,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - milestone: *771 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -167317,11 +167546,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - milestone: *771 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *773 + organization: *749 + repository: *750 sender: *4 required: - action @@ -167401,11 +167630,11 @@ webhooks: type: string enum: - opened - enterprise: *745 - installation: *746 - milestone: *777 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + milestone: *779 + organization: *749 + repository: *750 sender: *4 required: - action @@ -167484,11 +167713,11 @@ webhooks: type: string enum: - blocked - blocked_user: *765 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + blocked_user: *767 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -167567,11 +167796,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *765 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + blocked_user: *767 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -167650,9 +167879,9 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - membership: &778 + enterprise: *747 + installation: *748 + membership: &780 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -167762,8 +167991,8 @@ webhooks: - role - organization_url - user - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -167841,11 +168070,11 @@ webhooks: type: string enum: - member_added - enterprise: *745 - installation: *746 - membership: *778 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + membership: *780 + organization: *749 + repository: *750 sender: *4 required: - action @@ -167924,8 +168153,8 @@ webhooks: type: string enum: - member_invited - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -168047,10 +168276,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 - user: *765 + user: *767 required: - action - invitation @@ -168128,11 +168357,11 @@ webhooks: type: string enum: - member_removed - enterprise: *745 - installation: *746 - membership: *778 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + membership: *780 + organization: *749 + repository: *750 sender: *4 required: - action @@ -168219,11 +168448,11 @@ webhooks: properties: from: type: string - enterprise: *745 - installation: *746 - membership: *778 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + membership: *780 + organization: *749 + repository: *750 sender: *4 required: - action @@ -168300,9 +168529,9 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 package: description: Information about the package. type: object @@ -168825,7 +169054,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &779 + items: &781 title: Ruby Gems metadata type: object properties: @@ -168922,7 +169151,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -168998,9 +169227,9 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 package: description: Information about the package. type: object @@ -169362,7 +169591,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *779 + items: *781 source_url: type: string format: uri @@ -169433,7 +169662,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -169613,12 +169842,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *745 + enterprise: *747 id: type: integer - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - id @@ -169695,7 +169924,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &780 + personal_access_token_request: &782 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -169845,10 +170074,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *745 - organization: *747 + enterprise: *747 + organization: *749 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -169925,11 +170154,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *780 - enterprise: *745 - organization: *747 + personal_access_token_request: *782 + enterprise: *747 + organization: *749 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -170005,11 +170234,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *780 - enterprise: *745 - organization: *747 + personal_access_token_request: *782 + enterprise: *747 + organization: *749 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -170084,11 +170313,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *780 - organization: *747 - enterprise: *745 + personal_access_token_request: *782 + organization: *749 + enterprise: *747 sender: *4 - installation: *746 + installation: *748 required: - action - personal_access_token_request @@ -170193,7 +170422,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *781 + last_response: *783 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -170225,8 +170454,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 zen: description: Random string of GitHub zen. @@ -170471,10 +170700,10 @@ webhooks: - from required: - note - enterprise: *745 - installation: *746 - organization: *747 - project_card: &782 + enterprise: *747 + installation: *748 + organization: *749 + project_card: &784 title: Project Card type: object properties: @@ -170597,7 +170826,7 @@ webhooks: - creator - created_at - updated_at - repository: *748 + repository: *750 sender: *4 required: - action @@ -170678,11 +170907,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - project_card: *782 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_card: *784 + repository: *750 sender: *4 required: - action @@ -170762,9 +170991,9 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 project_card: title: Project Card type: object @@ -170894,7 +171123,7 @@ webhooks: repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -170988,11 +171217,11 @@ webhooks: - from required: - note - enterprise: *745 - installation: *746 - organization: *747 - project_card: *782 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_card: *784 + repository: *750 sender: *4 required: - action @@ -171086,9 +171315,9 @@ webhooks: - from required: - column_id - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 project_card: allOf: - title: Project Card @@ -171285,7 +171514,7 @@ webhooks: type: string required: - after_id - repository: *748 + repository: *750 sender: *4 required: - action @@ -171365,10 +171594,10 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 - organization: *747 - project: &784 + enterprise: *747 + installation: *748 + organization: *749 + project: &786 title: Project type: object properties: @@ -171495,7 +171724,7 @@ webhooks: - creator - created_at - updated_at - repository: *748 + repository: *750 sender: *4 required: - action @@ -171575,10 +171804,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - project_column: &783 + enterprise: *747 + installation: *748 + organization: *749 + project_column: &785 title: Project Column type: object properties: @@ -171618,7 +171847,7 @@ webhooks: - name - created_at - updated_at - repository: *748 + repository: *750 sender: *4 required: - action @@ -171697,14 +171926,14 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - project_column: *783 + enterprise: *747 + installation: *748 + organization: *749 + project_column: *785 repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -171793,11 +172022,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - project_column: *783 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_column: *785 + repository: *750 sender: *4 required: - action @@ -171877,11 +172106,11 @@ webhooks: type: string enum: - moved - enterprise: *745 - installation: *746 - organization: *747 - project_column: *783 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project_column: *785 + repository: *750 sender: *4 required: - action @@ -171961,11 +172190,11 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - project: *784 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 + repository: *750 sender: *4 required: - action @@ -172045,14 +172274,14 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - project: *784 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 repository: anyOf: - type: 'null' - - *748 + - *750 sender: *4 required: - action @@ -172153,11 +172382,11 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - project: *784 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 + repository: *750 sender: *4 required: - action @@ -172236,11 +172465,11 @@ webhooks: type: string enum: - reopened - enterprise: *745 - installation: *746 - organization: *747 - project: *784 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + project: *786 + repository: *750 sender: *4 required: - action @@ -172321,8 +172550,8 @@ webhooks: type: string enum: - closed - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -172404,8 +172633,8 @@ webhooks: type: string enum: - created - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -172487,8 +172716,8 @@ webhooks: type: string enum: - deleted - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -172610,8 +172839,8 @@ webhooks: type: string to: type: string - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -172695,7 +172924,7 @@ webhooks: type: string enum: - archived - changes: &788 + changes: &790 type: object properties: archived_at: @@ -172711,9 +172940,9 @@ webhooks: - string - 'null' format: date-time - installation: *746 - organization: *747 - projects_v2_item: &785 + installation: *748 + organization: *749 + projects_v2_item: &787 title: Projects v2 Item description: An item belonging to a project type: object @@ -172853,9 +173082,9 @@ webhooks: - 'null' to: type: string - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -172937,9 +173166,9 @@ webhooks: type: string enum: - created - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -173020,9 +173249,9 @@ webhooks: type: string enum: - deleted - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -173127,7 +173356,7 @@ webhooks: oneOf: - type: string - type: integer - - &786 + - &788 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -173151,7 +173380,7 @@ webhooks: required: - id - name - - &787 + - &789 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -173191,8 +173420,8 @@ webhooks: oneOf: - type: string - type: integer - - *786 - - *787 + - *788 + - *789 type: - 'null' - string @@ -173215,9 +173444,9 @@ webhooks: - 'null' required: - body - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -173314,9 +173543,9 @@ webhooks: type: - string - 'null' - installation: *746 - organization: *747 - projects_v2_item: *785 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -173399,10 +173628,10 @@ webhooks: type: string enum: - restored - changes: *788 - installation: *746 - organization: *747 - projects_v2_item: *785 + changes: *790 + installation: *748 + organization: *749 + projects_v2_item: *787 sender: *4 required: - action @@ -173484,8 +173713,8 @@ webhooks: type: string enum: - reopened - installation: *746 - organization: *747 + installation: *748 + organization: *749 projects_v2: *278 sender: *4 required: @@ -173567,9 +173796,9 @@ webhooks: type: string enum: - created - installation: *746 - organization: *747 - projects_v2_status_update: *789 + installation: *748 + organization: *749 + projects_v2_status_update: *791 sender: *4 required: - action @@ -173650,9 +173879,9 @@ webhooks: type: string enum: - deleted - installation: *746 - organization: *747 - projects_v2_status_update: *789 + installation: *748 + organization: *749 + projects_v2_status_update: *791 sender: *4 required: - action @@ -173798,9 +174027,9 @@ webhooks: - string - 'null' format: date - installation: *746 - organization: *747 - projects_v2_status_update: *789 + installation: *748 + organization: *749 + projects_v2_status_update: *791 sender: *4 required: - action @@ -173871,10 +174100,10 @@ webhooks: title: public event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - repository @@ -173951,13 +174180,13 @@ webhooks: type: string enum: - assigned - assignee: *765 - enterprise: *745 - installation: *746 - number: &790 + assignee: *767 + enterprise: *747 + installation: *748 + number: &792 description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -176328,7 +176557,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -176425,11 +176654,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -178793,7 +179022,7 @@ webhooks: - draft reason: type: string - repository: *748 + repository: *750 sender: *4 required: - action @@ -178890,11 +179119,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -181258,7 +181487,7 @@ webhooks: - draft reason: type: string - repository: *748 + repository: *750 sender: *4 required: - action @@ -181355,11 +181584,11 @@ webhooks: type: string enum: - closed - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: &791 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: &793 allOf: - *596 - type: object @@ -181423,7 +181652,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *748 + repository: *750 sender: *4 required: - action @@ -181504,12 +181733,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -181589,11 +181818,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *745 + enterprise: *747 milestone: *281 - number: *790 - organization: *747 - pull_request: &792 + number: *792 + organization: *749 + pull_request: &794 title: Pull Request type: object properties: @@ -183984,7 +184213,7 @@ webhooks: - active_lock_reason - draft version: '2026-03-10' - repository: *748 + repository: *750 sender: *4 required: - action @@ -184063,11 +184292,11 @@ webhooks: type: string enum: - dequeued - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -186435,7 +186664,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *748 + repository: *750 sender: *4 required: - action @@ -186567,12 +186796,12 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -186652,11 +186881,11 @@ webhooks: type: string enum: - enqueued - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -189009,7 +189238,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -189097,11 +189326,11 @@ webhooks: type: string enum: - labeled - enterprise: *745 - installation: *746 - label: *764 - number: *790 - organization: *747 + enterprise: *747 + installation: *748 + label: *766 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -191471,7 +191700,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -191567,10 +191796,10 @@ webhooks: type: string enum: - locked - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -193938,7 +194167,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -194033,12 +194262,12 @@ webhooks: type: string enum: - milestoned - enterprise: *745 + enterprise: *747 milestone: *281 - number: *790 - organization: *747 - pull_request: *792 - repository: *748 + number: *792 + organization: *749 + pull_request: *794 + repository: *750 sender: *4 required: - action @@ -194117,12 +194346,12 @@ webhooks: type: string enum: - opened - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -194203,12 +194432,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -194288,12 +194517,12 @@ webhooks: type: string enum: - reopened - enterprise: *745 - installation: *746 - number: *790 - organization: *747 - pull_request: *791 - repository: *748 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: *793 + repository: *750 sender: *4 required: - action @@ -194668,9 +194897,9 @@ webhooks: - start_side - side - reactions - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: type: object properties: @@ -196922,7 +197151,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *748 + repository: *750 sender: *4 required: - action @@ -197017,7 +197246,7 @@ webhooks: type: string enum: - deleted - comment: &794 + comment: &796 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -197310,9 +197539,9 @@ webhooks: - start_side - side - reactions - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: type: object properties: @@ -199552,7 +199781,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *748 + repository: *750 sender: *4 required: - action @@ -199647,11 +199876,11 @@ webhooks: type: string enum: - edited - changes: *793 - comment: *794 - enterprise: *745 - installation: *746 - organization: *747 + changes: *795 + comment: *796 + enterprise: *747 + installation: *748 + organization: *749 pull_request: type: object properties: @@ -201894,7 +202123,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *748 + repository: *750 sender: *4 required: - action @@ -201990,9 +202219,9 @@ webhooks: type: string enum: - dismissed - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -204247,7 +204476,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 + repository: *750 review: description: The review that was affected. type: object @@ -204513,9 +204742,9 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -206629,8 +206858,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 - review: &795 + repository: *750 + review: &797 description: The review that was affected. type: object properties: @@ -206876,12 +207105,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -209250,7 +209479,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_reviewer: title: User type: @@ -209336,12 +209565,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -211717,7 +211946,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211935,12 +212164,12 @@ webhooks: type: string enum: - review_requested - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -214311,7 +214540,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_reviewer: title: User type: @@ -214398,12 +214627,12 @@ webhooks: type: string enum: - review_requested - enterprise: *745 - installation: *746 + enterprise: *747 + installation: *748 number: description: The pull request number. type: integer - organization: *747 + organization: *749 pull_request: title: Pull Request type: object @@ -216765,7 +216994,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 requested_team: title: Team description: Groups of organization members that gives permissions @@ -216972,9 +217201,9 @@ webhooks: type: string enum: - submitted - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -219232,8 +219461,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 - review: *795 + repository: *750 + review: *797 sender: *4 required: - action @@ -219328,9 +219557,9 @@ webhooks: type: string enum: - resolved - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -221483,7 +221712,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 + repository: *750 sender: *4 thread: type: object @@ -221888,9 +222117,9 @@ webhooks: type: string enum: - unresolved - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 pull_request: title: Simple Pull Request type: object @@ -224026,7 +224255,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *748 + repository: *750 sender: *4 thread: type: object @@ -224367,7 +224596,7 @@ webhooks: - repository - organization - app - pull-request-synchronize: + pull-request-stacked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -224375,10 +224604,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request's head branch was updated. For example, the head - branch was updated from the base branch or new commits were pushed to the - head branch. - operationId: pull-request/synchronize + description: A pull request was added to a stack. + operationId: pull-request/stacked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -224422,21 +224649,17 @@ webhooks: content: application/json: schema: - title: pull_request synchronize event + title: pull_request stacked event type: object properties: action: type: string enum: - - synchronize - after: - type: string - before: - type: string - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + - stacked + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -225455,13 +225678,17 @@ webhooks: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -225676,15 +225903,23 @@ webhooks: master_branch: type: string merge_commit_message: - description: The default value for a merge commit message. + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: The default value for a merge commit message - title. + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string enum: - PR_TITLE @@ -226198,6 +226433,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -226793,13 +227029,11 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action - number - - before - - after - pull_request - repository - sender @@ -226830,7 +227064,7 @@ webhooks: - repository - organization - app - pull-request-unassigned: + pull-request-synchronize: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -226838,8 +227072,10 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A user was unassigned from a pull request. - operationId: pull-request/unassigned + description: A pull request's head branch was updated. For example, the head + branch was updated from the base branch or new commits were pushed to the + head branch. + operationId: pull-request/synchronize externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -226883,18 +227119,21 @@ webhooks: content: application/json: schema: - title: pull_request unassigned event + title: pull_request synchronize event type: object properties: action: type: string enum: - - unassigned - assignee: *796 - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + - synchronize + after: + type: string + before: + type: string + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -227256,9 +227495,664 @@ webhooks: type: object properties: label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User type: - - string + - object - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a + draft. + type: boolean + head: + type: object + properties: + label: + type: string ref: type: string repo: @@ -227479,684 +228373,15 @@ webhooks: master_branch: type: string merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: - - string - - 'null' - changed_files: - type: integer - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: - - string - - 'null' - ref: - type: string - repo: - title: Repository - description: A git repository - type: - - object - - 'null' - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. + description: The default value for a merge commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + description: The default value for a merge commit message + title. type: string enum: - PR_TITLE @@ -228670,7 +228895,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -229266,13 +229490,16 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action - number + - before + - after - pull_request - repository + - sender x-github-breaking-changes: - changeset: remove_use_squash_pr_title_as_default patch: @@ -229300,7 +229527,7 @@ webhooks: - repository - organization - app - pull-request-unlabeled: + pull-request-unassigned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -229308,8 +229535,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was removed from a pull request. - operationId: pull-request/unlabeled + description: A user was unassigned from a pull request. + operationId: pull-request/unassigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -229353,18 +229580,18 @@ webhooks: content: application/json: schema: - title: pull_request unlabeled event + title: pull_request unassigned event type: object properties: action: type: string enum: - - unlabeled - enterprise: *745 - installation: *746 - label: *764 - number: *790 - organization: *747 + - unassigned + assignee: *798 + enterprise: *747 + installation: *748 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -229726,7 +229953,9 @@ webhooks: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: @@ -230608,15 +230837,23 @@ webhooks: master_branch: type: string merge_commit_message: - description: The default value for a merge commit message. + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: The default value for a merge commit message - title. + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string enum: - PR_TITLE @@ -231130,6 +231367,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -231725,14 +231963,13 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action - number - pull_request - repository - - sender x-github-breaking-changes: - changeset: remove_use_squash_pr_title_as_default patch: @@ -231760,7 +231997,7 @@ webhooks: - repository - organization - app - pull-request-unlocked: + pull-request-unlabeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -231768,9 +232005,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was unlocked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/unlocked + description: A label was removed from a pull request. + operationId: pull-request/unlabeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -231814,17 +232050,18 @@ webhooks: content: application/json: schema: - title: pull_request unlocked event + title: pull_request unlabeled event type: object properties: action: type: string enum: - - unlocked - enterprise: *745 - installation: *746 - number: *790 - organization: *747 + - unlabeled + enterprise: *747 + installation: *748 + label: *766 + number: *792 + organization: *749 pull_request: title: Pull Request type: object @@ -231988,6 +232225,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -232061,6 +232299,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -232094,7 +232333,9 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -232839,7 +233080,9 @@ webhooks: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: @@ -233062,23 +233305,15 @@ webhooks: master_branch: type: string merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. + description: The default value for a merge commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + description: The default value for a merge commit message + title. type: string enum: - PR_TITLE @@ -233680,6 +233915,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -233823,6 +234059,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -233934,6 +234171,15 @@ webhooks: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -234130,6 +234376,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -234175,7 +234422,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *748 + repository: *750 sender: *4 required: - action @@ -234210,20 +234457,19 @@ webhooks: - repository - organization - app - push: + pull-request-unlocked: post: summary: |- - This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch - and tag deletions, use the [`delete`](#delete) webhook event. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. - operationId: push + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Conversation on a pull request was unlocked. For more information, + see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/unlocked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#push + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -234237,7 +234483,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: push + example: pull_request schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -234265,500 +234511,2951 @@ webhooks: content: application/json: schema: - title: push event + title: pull_request unlocked event type: object properties: - after: - description: The SHA of the most recent commit on `ref` after the - push. - type: string - base_ref: - type: - - string - - 'null' - before: - description: The SHA of the most recent commit on `ref` before the - push. - type: string - commits: - description: An array of commit objects describing the pushed commits. - (Pushed commits are all commits that are included in the `compare` - between the `before` commit and the `after` commit.) The array - includes a maximum of 2048 commits. If necessary, you can use - the [Commits API](https://docs.github.com/rest/commits) to fetch - additional commits. - type: array - items: - title: Commit - type: object - properties: - added: - description: An array of files added in the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that - have been pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - compare: - description: URL that shows the changes in this `ref` update, from - the `before` commit to the `after` commit. For a newly created - `ref` that is directly based on the default branch, this is the - comparison between the head of the default branch and the `after` - commit. Otherwise, this shows all commits until the `after` commit. - type: string - created: - description: Whether this push created the `ref`. - type: boolean - deleted: - description: Whether this push deleted the `ref`. - type: boolean - enterprise: *745 - forced: - description: Whether this push was a force push of the `ref`. - type: boolean - head_commit: - title: Commit - type: - - object - - 'null' - properties: - added: - description: An array of files added in the commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that have - been pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - installation: *746 - organization: *747 - pusher: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - name - ref: - description: 'The full git ref that was pushed. Example: `refs/heads/main` - or `refs/tags/v3.14.1`.' + action: type: string - repository: - title: Repository - description: A git repository + enum: + - unlocked + enterprise: *747 + installation: *748 + number: *792 + organization: *749 + pull_request: + title: Pull Request type: object properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: + _links: 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 - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create pull requests: - all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: type: - string - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: type: integer - organization: - type: string - owner: + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a + draft. + type: boolean + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull + request. + type: boolean + merge_commit_sha: + type: + - string + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within + its repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: + - boolean + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have + for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + repository: *750 + sender: *4 + required: + - action + - number + - pull_request + - repository + - sender + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + - op: remove + path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + version: '2026-03-10' + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/properties/pull_request/properties/merge_commit_sha" + - op: remove + path: "/properties/pull_request/required/17" + version: '2026-03-10' + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app + push: + post: + summary: |- + This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, + when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch + and tag deletions, use the [`delete`](#delete) webhook event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + + > [!NOTE] + > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. + operationId: push + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#push + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: push + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: push event + type: object + properties: + after: + description: The SHA of the most recent commit on `ref` after the + push. + type: string + base_ref: + type: + - string + - 'null' + before: + description: The SHA of the most recent commit on `ref` before the + push. + type: string + commits: + description: An array of commit objects describing the pushed commits. + (Pushed commits are all commits that are included in the `compare` + between the `before` commit and the `after` commit.) The array + includes a maximum of 2048 commits. If necessary, you can use + the [Commits API](https://docs.github.com/rest/commits) to fetch + additional commits. + type: array + items: + title: Commit + type: object + properties: + added: + description: An array of files added in the commit. A maximum + of 3000 changed files will be reported per commit. + type: array + items: + type: string + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + distinct: + description: Whether this commit is distinct from any that + have been pushed before. + type: boolean + id: + type: string + message: + description: The commit message. + type: string + modified: + description: An array of files modified by the commit. A maximum + of 3000 changed files will be reported per commit. + type: array + items: + type: string + removed: + description: An array of files removed in the commit. A maximum + of 3000 changed files will be reported per commit. + type: array + items: + type: string + timestamp: + description: The ISO 8601 timestamp of the commit. + type: string + format: date-time + tree_id: + type: string + url: + description: URL that points to the commit API resource. + type: string + format: uri + required: + - id + - tree_id + - distinct + - message + - timestamp + - url + - author + - committer + compare: + description: URL that shows the changes in this `ref` update, from + the `before` commit to the `after` commit. For a newly created + `ref` that is directly based on the default branch, this is the + comparison between the head of the default branch and the `after` + commit. Otherwise, this shows all commits until the `after` commit. + type: string + created: + description: Whether this push created the `ref`. + type: boolean + deleted: + description: Whether this push deleted the `ref`. + type: boolean + enterprise: *747 + forced: + description: Whether this push was a force push of the `ref`. + type: boolean + head_commit: + title: Commit + type: + - object + - 'null' + properties: + added: + description: An array of files added in the commit. + type: array + items: + type: string + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + distinct: + description: Whether this commit is distinct from any that have + been pushed before. + type: boolean + id: + type: string + message: + description: The commit message. + type: string + modified: + description: An array of files modified by the commit. + type: array + items: + type: string + removed: + description: An array of files removed in the commit. + type: array + items: + type: string + timestamp: + description: The ISO 8601 timestamp of the commit. + type: string + format: date-time + tree_id: + type: string + url: + description: URL that points to the commit API resource. + type: string + format: uri + required: + - id + - tree_id + - distinct + - message + - timestamp + - url + - author + - committer + installation: *748 + organization: *749 + pusher: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - name + ref: + description: 'The full git ref that was pushed. Example: `refs/heads/main` + or `refs/tags/v3.14.1`.' + type: string + repository: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + 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 + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: title: User type: - object @@ -235088,9 +237785,9 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 registry_package: type: object properties: @@ -235567,7 +238264,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *779 + items: *781 summary: type: string tag_name: @@ -235623,7 +238320,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -235701,9 +238398,9 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 registry_package: type: object properties: @@ -236015,7 +238712,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *779 + items: *781 summary: type: string tag_name: @@ -236065,7 +238762,7 @@ webhooks: - owner - package_version - registry - repository: *748 + repository: *750 sender: *4 required: - action @@ -236142,10 +238839,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - release: &797 + enterprise: *747 + installation: *748 + organization: *749 + release: &799 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -236476,7 +239173,7 @@ webhooks: - updated_at - zipball_url - body - repository: *748 + repository: *750 sender: *4 required: - action @@ -236553,11 +239250,11 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - release: *797 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *799 + repository: *750 sender: *4 required: - action @@ -236674,11 +239371,11 @@ webhooks: type: boolean required: - to - enterprise: *745 - installation: *746 - organization: *747 - release: *797 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *799 + repository: *750 sender: *4 required: - action @@ -236756,9 +239453,9 @@ webhooks: type: string enum: - prereleased - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -237094,7 +239791,7 @@ webhooks: - string - 'null' format: uri - repository: *748 + repository: *750 sender: *4 required: - action @@ -237170,10 +239867,10 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 - release: &798 + enterprise: *747 + installation: *748 + organization: *749 + release: &800 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -237506,7 +240203,7 @@ webhooks: - string - 'null' format: uri - repository: *748 + repository: *750 sender: *4 required: - action @@ -237582,11 +240279,11 @@ webhooks: type: string enum: - released - enterprise: *745 - installation: *746 - organization: *747 - release: *797 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *799 + repository: *750 sender: *4 required: - action @@ -237662,11 +240359,11 @@ webhooks: type: string enum: - unpublished - enterprise: *745 - installation: *746 - organization: *747 - release: *798 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + release: *800 + repository: *750 sender: *4 required: - action @@ -237742,11 +240439,11 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - repository_advisory: *666 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + repository_advisory: *668 sender: *4 required: - action @@ -237822,11 +240519,11 @@ webhooks: type: string enum: - reported - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - repository_advisory: *666 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + repository_advisory: *668 sender: *4 required: - action @@ -237902,10 +240599,10 @@ webhooks: type: string enum: - archived - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -237982,10 +240679,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238063,10 +240760,10 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238151,10 +240848,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238269,10 +240966,10 @@ webhooks: - 'null' items: type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238344,10 +241041,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 status: type: string @@ -238428,10 +241125,10 @@ webhooks: type: string enum: - privatized - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238508,10 +241205,10 @@ webhooks: type: string enum: - publicized - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238605,10 +241302,10 @@ webhooks: - name required: - repository - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -238688,10 +241385,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 repository_ruleset: *323 sender: *4 required: @@ -238770,10 +241467,10 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 repository_ruleset: *323 sender: *4 required: @@ -238852,10 +241549,10 @@ webhooks: type: string enum: - edited - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 repository_ruleset: *323 changes: type: object @@ -239163,10 +241860,10 @@ webhooks: - from required: - owner - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -239244,10 +241941,10 @@ webhooks: type: string enum: - unarchived - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -239325,7 +242022,7 @@ webhooks: type: string enum: - create - alert: &799 + alert: &801 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -239450,10 +242147,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -239663,10 +242360,10 @@ webhooks: type: string enum: - dismissed - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -239744,11 +242441,11 @@ webhooks: type: string enum: - reopen - alert: *799 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *801 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -239950,10 +242647,10 @@ webhooks: enum: - fixed - open - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -240031,7 +242728,7 @@ webhooks: type: string enum: - assigned - alert: &800 + alert: &803 type: object properties: number: *180 @@ -240170,11 +242867,12 @@ webhooks: anyOf: - type: 'null' - *4 + metadata: *802 assignee: *4 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -240252,11 +242950,11 @@ webhooks: type: string enum: - created - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -240337,11 +243035,11 @@ webhooks: type: string enum: - created - alert: *800 - installation: *746 - location: *801 - organization: *747 - repository: *748 + alert: *803 + installation: *748 + location: *804 + organization: *749 + repository: *750 sender: *4 required: - location @@ -240519,6 +243217,168 @@ webhooks: - repository - organization - app + secret-scanning-alert-metadata-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: Metadata was created for a secret scanning alert. + operationId: secret-scanning-alert/metadata-created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: secret_scanning_alert + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + 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: secret_scanning_alert metadata created event + type: object + properties: + action: + type: string + enum: + - metadata_created + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-metadata-removed: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: Metadata was removed from a secret scanning alert. + operationId: secret-scanning-alert/metadata-removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: secret_scanning_alert + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + 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: secret_scanning_alert metadata removed event + type: object + properties: + action: + type: string + enum: + - metadata_removed + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-publicly-leaked: post: summary: |- @@ -240579,11 +243439,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -240661,11 +243521,11 @@ webhooks: type: string enum: - reopened - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -240743,11 +243603,11 @@ webhooks: type: string enum: - resolved - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -240825,12 +243685,12 @@ webhooks: type: string enum: - unassigned - alert: *800 + alert: *803 assignee: *4 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -240908,11 +243768,11 @@ webhooks: type: string enum: - validated - alert: *800 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + alert: *803 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -241042,10 +243902,10 @@ webhooks: - organization - enterprise - - repository: *748 - enterprise: *745 - installation: *746 - organization: *747 + repository: *750 + enterprise: *747 + installation: *748 + organization: *749 sender: *4 required: - action @@ -241123,11 +243983,11 @@ webhooks: type: string enum: - published - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - security_advisory: &802 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + security_advisory: &805 description: The details of the security advisory, including summary, description, and severity. type: object @@ -241331,11 +244191,11 @@ webhooks: type: string enum: - updated - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 - security_advisory: *802 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 + security_advisory: *805 sender: *4 required: - action @@ -241408,10 +244268,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -241606,9 +244466,9 @@ webhooks: type: object properties: security_and_analysis: *296 - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: *340 sender: *4 required: @@ -241687,12 +244547,12 @@ webhooks: type: string enum: - cancelled - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: &803 + sponsorship: &806 type: object properties: created_at: @@ -241997,12 +244857,12 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - sponsorship @@ -242090,12 +244950,12 @@ webhooks: type: string required: - from - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - changes @@ -242172,17 +245032,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &804 + effective_date: &807 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - sponsorship @@ -242256,7 +245116,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &805 + changes: &808 type: object properties: tier: @@ -242300,13 +245160,13 @@ webhooks: - from required: - tier - effective_date: *804 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + effective_date: *807 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - changes @@ -242383,13 +245243,13 @@ webhooks: type: string enum: - tier_changed - changes: *805 - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + changes: *808 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - sponsorship: *803 + sponsorship: *806 required: - action - changes @@ -242463,10 +245323,10 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -242550,10 +245410,10 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -242987,15 +245847,15 @@ webhooks: type: - string - 'null' - enterprise: *745 + enterprise: *747 id: description: The unique identifier of the status. type: integer - installation: *746 + installation: *748 name: type: string - organization: *747 - repository: *748 + organization: *749 + repository: *750 sender: *4 sha: description: The Commit SHA. @@ -243111,9 +245971,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -243202,9 +246062,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -243293,9 +246153,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -243384,9 +246244,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *746 - organization: *747 - repository: *748 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -243462,12 +246322,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - team: &806 + team: &809 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -243697,9 +246557,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -244169,7 +247029,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -244245,9 +247105,9 @@ webhooks: type: string enum: - created - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -244717,7 +247577,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -244794,9 +247654,9 @@ webhooks: type: string enum: - deleted - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -245266,7 +248126,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -245410,9 +248270,9 @@ webhooks: - from required: - permissions - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -245882,7 +248742,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - changes @@ -245960,9 +248820,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *745 - installation: *746 - organization: *747 + enterprise: *747 + installation: *748 + organization: *749 repository: title: Repository description: A git repository @@ -246432,7 +249292,7 @@ webhooks: - topics - visibility sender: *4 - team: *806 + team: *809 required: - action - team @@ -246508,10 +249368,10 @@ webhooks: type: string enum: - started - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 required: - action @@ -246584,17 +249444,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *745 + enterprise: *747 inputs: type: - object - 'null' additionalProperties: true - installation: *746 - organization: *747 + installation: *748 + organization: *749 ref: type: string - repository: *748 + repository: *750 sender: *4 workflow: type: string @@ -246676,10 +249536,10 @@ webhooks: type: string enum: - completed - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: allOf: @@ -247014,10 +249874,10 @@ webhooks: type: string enum: - in_progress - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: allOf: @@ -247378,10 +250238,10 @@ webhooks: type: string enum: - queued - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: type: object @@ -247606,10 +250466,10 @@ webhooks: type: string enum: - waiting - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 workflow_job: type: object @@ -247836,12 +250696,12 @@ webhooks: type: string enum: - completed - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object @@ -248860,12 +251720,12 @@ webhooks: type: string enum: - in_progress - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object @@ -249869,12 +252729,12 @@ webhooks: type: string enum: - requested - enterprise: *745 - installation: *746 - organization: *747 - repository: *748 + enterprise: *747 + installation: *748 + organization: *749 + repository: *750 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 4f4bb3037a..be49fa8248 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -59526,115 +59526,123 @@ "content": { "application/json": { "schema": { - "type": "array", - "description": "Array of vulnerabilities in OSV format to synchronize", - "items": { - "title": "OSV Vulnerability", - "description": "A vulnerability in OSV (Open Source Vulnerability) format", - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the vulnerability from the external system", - "examples": [ - "MVS-2026-001" - ] - }, - "schema_version": { - "type": "string", - "description": "The OSV schema version", - "examples": [ - "1.4.0" - ] - }, - "summary": { - "type": "string", - "description": "A short summary of the vulnerability", - "examples": [ - "Example vulnerability summary" - ] - }, - "details": { - "type": "string", - "description": "Detailed description of the vulnerability" - }, - "aliases": { - "type": "array", - "description": "IDs for the same vulnerability in other databases. Only CVE IDs are used (to populate the vulnerability's CVE identifier); other aliases are ignored.", - "items": { - "type": "string" - }, - "examples": [ - "CVE-2026-12345" - ] - }, - "severity": { - "type": "array", - "description": "Severity information for the vulnerability", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of severity scoring (e.g., CVSS_V3)" + "type": "object", + "required": [ + "vulnerabilities" + ], + "properties": { + "vulnerabilities": { + "type": "array", + "description": "Array of vulnerabilities in OSV format to synchronize", + "items": { + "title": "OSV Vulnerability", + "description": "A vulnerability in OSV (Open Source Vulnerability) format", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the vulnerability from the external system", + "examples": [ + "MVS-2026-001" + ] + }, + "schema_version": { + "type": "string", + "description": "The OSV schema version", + "examples": [ + "1.4.0" + ] + }, + "summary": { + "type": "string", + "description": "A short summary of the vulnerability", + "examples": [ + "Example vulnerability summary" + ] + }, + "details": { + "type": "string", + "description": "Detailed description of the vulnerability" + }, + "aliases": { + "type": "array", + "description": "IDs for the same vulnerability in other databases. Only CVE IDs are used (to populate the vulnerability's CVE identifier); other aliases are ignored.", + "items": { + "type": "string" }, - "score": { - "type": "string", - "description": "The severity score or vector string" - } - } - } - }, - "affected": { - "type": "array", - "description": "Packages and versions affected by the vulnerability", - "items": { - "type": "object", - "properties": { - "package": { + "examples": [ + "CVE-2026-12345" + ] + }, + "severity": { + "type": "array", + "description": "Severity information for the vulnerability", + "items": { "type": "object", "properties": { - "ecosystem": { + "type": { "type": "string", - "description": "The package ecosystem (e.g., npm, pip, maven)" + "description": "The type of severity scoring (e.g., CVSS_V3)" }, - "name": { + "score": { "type": "string", - "description": "The package name" + "description": "The severity score or vector string" } } - }, - "ranges": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "object", - "properties": { - "introduced": { - "type": "string", - "description": "The version that introduced the vulnerability" - }, - "fixed": { - "type": "string", - "description": "The version that fixed the vulnerability" - }, - "last_affected": { - "type": "string", - "description": "The last affected version" - }, - "limit": { - "type": "string", - "description": "The upper limit of the affected range" + } + }, + "affected": { + "type": "array", + "description": "Packages and versions affected by the vulnerability", + "items": { + "type": "object", + "properties": { + "package": { + "type": "object", + "properties": { + "ecosystem": { + "type": "string", + "description": "The package ecosystem (e.g., npm, pip, maven)" + }, + "name": { + "type": "string", + "description": "The package name" + } + } + }, + "ranges": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "introduced": { + "type": "string", + "description": "The version that introduced the vulnerability" + }, + "fixed": { + "type": "string", + "description": "The version that fixed the vulnerability" + }, + "last_affected": { + "type": "string", + "description": "The last affected version" + }, + "limit": { + "type": "string", + "description": "The upper limit of the affected range" + } + } } } } @@ -59642,80 +59650,82 @@ } } } - } - } - }, - "references": { - "type": "array", - "description": "URLs for more information about the vulnerability", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of reference. Supported values: PACKAGE, ADVISORY, WEB, FIX, ARTICLE, REPORT, EVIDENCE. References with other types are ignored." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The reference URL" + }, + "references": { + "type": "array", + "description": "URLs for more information about the vulnerability", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reference. Supported values: PACKAGE, ADVISORY, WEB, FIX, ARTICLE, REPORT, EVIDENCE. References with other types are ignored." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The reference URL" + } + } } + }, + "published": { + "type": "string", + "format": "date-time", + "description": "When the vulnerability was first published" + }, + "modified": { + "type": "string", + "format": "date-time", + "description": "When the vulnerability was last modified" + }, + "withdrawn": { + "type": "string", + "format": "date-time", + "description": "When the vulnerability was withdrawn. If present, the vulnerability will be marked as withdrawn." } } }, - "published": { - "type": "string", - "format": "date-time", - "description": "When the vulnerability was first published" - }, - "modified": { - "type": "string", - "format": "date-time", - "description": "When the vulnerability was last modified" - }, - "withdrawn": { - "type": "string", - "format": "date-time", - "description": "When the vulnerability was withdrawn. If present, the vulnerability will be marked as withdrawn." - } + "minItems": 1, + "maxItems": 100 } - }, - "minItems": 1, - "maxItems": 100 + } }, "examples": { "default": { - "value": [ - { - "id": "MVS-2026-001", - "schema_version": "1.4.0", - "summary": "Example vulnerability summary", - "aliases": [ - "GHSA-xxxx-xxxx-xxxx" - ], - "affected": [ - { - "package": { - "ecosystem": "npm", - "name": "example-package" - }, - "ranges": [ - { - "type": "SEMVER", - "events": [ - { - "introduced": "1.0.0" - }, - { - "fixed": "1.0.1" - } - ] - } - ] - } - ] - } - ] + "value": { + "vulnerabilities": [ + { + "id": "MVS-2026-001", + "schema_version": "1.4.0", + "summary": "Example vulnerability summary", + "aliases": [ + "GHSA-xxxx-xxxx-xxxx" + ], + "affected": [ + { + "package": { + "ecosystem": "npm", + "name": "example-package" + }, + "ranges": [ + { + "type": "SEMVER", + "events": [ + { + "introduced": "1.0.0" + }, + { + "fixed": "1.0.1" + } + ] + } + ] + } + ] + } + ] + } } } } @@ -67804,6 +67814,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -69164,6 +69217,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -70646,6 +70742,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -72497,6 +72636,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -73853,6 +74035,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -75324,6 +75549,24 @@ "schema": { "type": "boolean" } + }, + { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -304668,6 +304911,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -305969,6 +306255,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -307344,6 +307673,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -309483,6 +309855,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -310809,6 +311224,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -312180,6 +312638,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -313769,6 +314270,24 @@ "schema": { "type": "boolean" } + }, + { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -731490,6 +732009,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -733358,6 +733920,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -734526,6 +735131,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -735907,6 +736555,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -738065,6 +738756,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -739248,6 +739982,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -740625,6 +741402,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -742230,6 +743050,24 @@ "schema": { "type": "boolean" } + }, + { + "name": "included_metadata", + "in": "query", + "description": "A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner_email_hash", + "in": "query", + "description": "Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -745392,6 +746230,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -745420,7 +746280,13 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ] } } } @@ -747073,6 +747939,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -747121,6 +748009,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -1668877,11 +1669771,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-stacked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1668948,21 +1669842,15 @@ "content": { "application/json": { "schema": { - "title": "pull_request synchronize event", + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "synchronize" + "stacked" ] }, - "after": { - "type": "string" - }, - "before": { - "type": "string" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", @@ -1670519,7 +1671407,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1670527,7 +1671418,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1670811,7 +1671705,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1670820,7 +1671714,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": [ "PR_TITLE", @@ -1671487,7 +1672381,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1673958,8 +1674853,6 @@ "required": [ "action", "number", - "before", - "after", "pull_request", "repository", "sender" @@ -1673985,11 +1674878,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1674056,114 +1674949,20 @@ "content": { "application/json": { "schema": { - "title": "pull_request unassigned event", + "title": "pull_request synchronize event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unassigned" + "synchronize" ] }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "after": { + "type": "string" + }, + "before": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -1674879,10 +1675678,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1675724,10 +1676520,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1675735,10 +1676528,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1676022,7 +1676812,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1676031,7 +1676821,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1676698,8 +1677488,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -1679170,8 +1679959,11 @@ "required": [ "action", "number", + "before", + "after", "pull_request", - "repository" + "repository", + "sender" ] } } @@ -1679194,11 +1679986,11 @@ } } }, - "pull-request-unlabeled": { + "pull-request-unassigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1679265,13 +1680057,113 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlabeled event", + "title": "pull_request unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" + "unassigned" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -1679389,49 +1680281,6 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "number": { "description": "The pull request number.", "type": "integer" @@ -1680031,7 +1680880,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1681171,7 +1682023,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1681180,7 +1682032,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": [ "PR_TITLE", @@ -1681847,7 +1682699,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1684319,8 +1685172,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ] } } @@ -1684343,11 +1685195,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1684414,13 +1685266,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlocked event", + "title": "pull_request unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlocked" + "unlabeled" ] }, "enterprise": { @@ -1684538,6 +1685390,49 @@ "node_id" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "number": { "description": "The pull request number.", "type": "integer" @@ -1684863,7 +1685758,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1684964,7 +1685860,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1685010,7 +1685907,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -1685974,7 +1686874,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1686269,7 +1687172,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1686278,7 +1687181,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1687066,7 +1687969,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1687260,7 +1688164,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1687408,7 +1688313,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -1687671,7 +1688585,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1689429,12 +1690344,13 @@ } } }, - "push": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1689456,7 +1690372,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "push", + "example": "pull_request", "schema": { "type": "string" } @@ -1689499,158 +1690415,15 @@ "content": { "application/json": { "schema": { - "title": "push event", + "title": "pull_request unlocked event", "type": "object", "properties": { - "after": { - "description": "The SHA of the most recent commit on `ref` after the push.", - "type": "string" - }, - "base_ref": { - "type": [ - "string", - "null" + "action": { + "type": "string", + "enum": [ + "unlocked" ] }, - "before": { - "description": "The SHA of the most recent commit on `ref` before the push.", - "type": "string" - }, - "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest/rest/commits) to fetch additional commits.", - "type": "array", - "items": { - "title": "Commit", - "type": "object", - "properties": { - "added": { - "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "distinct": { - "description": "Whether this commit is distinct from any that have been pushed before.", - "type": "boolean" - }, - "id": { - "type": "string" - }, - "message": { - "description": "The commit message.", - "type": "string" - }, - "modified": { - "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "removed": { - "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "timestamp": { - "description": "The ISO 8601 timestamp of the commit.", - "type": "string", - "format": "date-time" - }, - "tree_id": { - "type": "string" - }, - "url": { - "description": "URL that points to the commit API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "tree_id", - "distinct", - "message", - "timestamp", - "url", - "author", - "committer" - ] - } - }, - "compare": { - "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.", - "type": "string" - }, - "created": { - "description": "Whether this push created the `ref`.", - "type": "boolean" - }, - "deleted": { - "description": "Whether this push deleted the `ref`.", - "type": "boolean" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", @@ -1689741,132 +1690514,6 @@ "avatar_url" ] }, - "forced": { - "description": "Whether this push was a force push of the `ref`.", - "type": "boolean" - }, - "head_commit": { - "title": "Commit", - "type": [ - "object", - "null" - ], - "properties": { - "added": { - "description": "An array of files added in the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "distinct": { - "description": "Whether this commit is distinct from any that have been pushed before.", - "type": "boolean" - }, - "id": { - "type": "string" - }, - "message": { - "description": "The commit message.", - "type": "string" - }, - "modified": { - "description": "An array of files modified by the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "removed": { - "description": "An array of files removed in the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "timestamp": { - "description": "The ISO 8601 timestamp of the commit.", - "type": "string", - "format": "date-time" - }, - "tree_id": { - "type": "string" - }, - "url": { - "description": "URL that points to the commit API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "tree_id", - "distinct", - "message", - "timestamp", - "url", - "author", - "committer" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1689892,6 +1690539,10 @@ "node_id" ] }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1689991,365 +1690642,146 @@ "description" ] }, - "pusher": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "ref": { - "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.", - "type": "string" - }, - "repository": { - "title": "Repository", - "description": "A git repository", + "pull_request": { + "title": "Pull Request", "type": "object", "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "custom_properties": { + "_links": { "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 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "type": "boolean", - "default": true - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], "properties": { - "key": { - "type": "string" + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "name": { - "type": "string" + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "node_id": { - "type": "string" + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "spdx_id": { - "type": "string" + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] } }, "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" ] }, - "master_branch": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { + "active_lock_reason": { "type": [ "string", "null" ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, - "open_issues_count": { + "additions": { "type": "integer" }, - "organization": { - "type": "string" - }, - "owner": { + "assignee": { "title": "User", "type": [ "object", @@ -1690448,864 +1690880,181 @@ "id" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { + "assignees": { "type": "array", "items": { - "type": "string" + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] } }, - "trees_url": { - "type": "string", - "format": "uri-template" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "visibility": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", "enum": [ - "public", - "private", - "internal" - ] - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private", - "owner", - "html_url", - "description", - "fork", - "url", - "forks_url", - "keys_url", - "collaborators_url", - "teams_url", - "hooks_url", - "issue_events_url", - "events_url", - "assignees_url", - "branches_url", - "tags_url", - "blobs_url", - "git_tags_url", - "git_refs_url", - "trees_url", - "statuses_url", - "languages_url", - "stargazers_url", - "contributors_url", - "subscribers_url", - "subscription_url", - "commits_url", - "git_commits_url", - "comments_url", - "issue_comment_url", - "contents_url", - "compare_url", - "merges_url", - "archive_url", - "downloads_url", - "issues_url", - "pulls_url", - "milestones_url", - "notifications_url", - "labels_url", - "releases_url", - "deployments_url", - "created_at", - "updated_at", - "pushed_at", - "git_url", - "ssh_url", - "clone_url", - "svn_url", - "homepage", - "size", - "stargazers_count", - "watchers_count", - "language", - "has_issues", - "has_projects", - "has_downloads", - "has_wiki", - "has_pages", - "has_discussions", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] - }, - "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": [ - "ref", - "before", - "after", - "created", - "deleted", - "forced", - "base_ref", - "compare", - "commits", - "head_commit", - "repository", - "pusher" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "push", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "registry-package-published": { - "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package" - }, - "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": "registry_package", - "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": { - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "published" - ] - }, - "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" - ] - }, - "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" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "description": { + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", "type": [ - "string", + "object", "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" - ] - }, - "registry_package": { - "type": "object", - "properties": { - "created_at": { - "type": [ - "string", - "null" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "owner": { - "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" - }, - "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" + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] }, - "url": { + "commit_title": { + "description": "Title for the merge commit message.", "type": "string" }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" - ] - }, - "package_type": { - "type": "string" - }, - "package_version": { - "type": [ - "object", - "null" - ], - "properties": { - "author": { - "type": "object", + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1691313,32 +1691062,46 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" @@ -1691346,469 +1691109,415 @@ }, "required": [ "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" + "id" ] }, - "body": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - "body_html": { + "ref": { "type": "string" }, - "container_metadata": { + "repo": { + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { - "labels": { - "type": [ - "object", - "null" - ] + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false }, - "manifest": { - "type": [ - "object", - "null" - ] + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" }, - "tag": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - } - }, - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "docker_metadata": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "installation_command": { - "type": "string" - }, - "manifest": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - }, - "name": { - "type": "string" - }, - "npm_metadata": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true }, - "version": { - "type": "string" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true }, - "npm_user": { - "type": "string" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true }, - "author": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], - "type": [ - "null", - "string", - "object" - ] + "allow_update_branch": { + "type": "boolean" }, - "bugs": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], - "type": [ - "null", - "string", - "object" - ] + "archive_url": { + "type": "string", + "format": "uri-template" }, - "dependencies": { - "type": "object" + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false }, - "dev_dependencies": { - "type": "object" + "assignees_url": { + "type": "string", + "format": "uri-template" }, - "peer_dependencies": { - "type": "object" + "blobs_url": { + "type": "string", + "format": "uri-template" }, - "optional_dependencies": { - "type": "object" + "branches_url": { + "type": "string", + "format": "uri-template" }, - "description": { - "type": "string" + "clone_url": { + "type": "string", + "format": "uri" }, - "dist": { + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { "oneOf": [ { - "type": "string" + "type": "integer" }, { - "type": "object" + "type": "string", + "format": "date-time" } - ], - "type": [ - "null", - "string", - "object" ] }, - "git_head": { - "type": "string" - }, - "homepage": { + "default_branch": { + "description": "The default branch of the repository.", "type": "string" }, - "license": { - "type": "string" + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false }, - "main": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri" }, - "repository": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], + "description": { "type": [ - "null", "string", - "object" + "null" ] }, - "scripts": { - "type": "object" + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" }, - "id": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri" }, - "node_version": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri" }, - "npm_version": { + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { "type": "string" }, - "has_shrinkwrap": { - "type": "boolean" + "git_commits_url": { + "type": "string", + "format": "uri-template" }, - "maintainers": { - "type": "array", - "items": { - "type": "string" - } + "git_refs_url": { + "type": "string", + "format": "uri-template" }, - "contributors": { - "type": "array", - "items": { - "type": "string" - } + "git_tags_url": { + "type": "string", + "format": "uri-template" }, - "engines": { - "type": "object" + "git_url": { + "type": "string", + "format": "uri" }, - "keywords": { - "type": "array", - "items": { - "type": "string" - } + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true }, - "files": { - "type": "array", - "items": { - "type": "string" - } + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true }, - "bin": { - "type": "object" + "has_pages": { + "type": "boolean" }, - "man": { - "type": "object" + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true }, - "directories": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { "type": [ - "null", "string", - "object" + "null" ] }, - "os": { - "type": "array", - "items": { - "type": "string" - } + "hooks_url": { + "type": "string", + "format": "uri" }, - "cpu": { - "type": "array", - "items": { - "type": "string" - } + "html_url": { + "type": "string", + "format": "uri" }, - "readme": { - "type": "string" + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" }, - "installation_command": { - "type": "string" + "is_template": { + "type": "boolean" }, - "release_id": { - "type": "integer" + "issue_comment_url": { + "type": "string", + "format": "uri-template" }, - "commit_oid": { - "type": "string" + "issue_events_url": { + "type": "string", + "format": "uri-template" }, - "published_via_actions": { - "type": "boolean" + "issues_url": { + "type": "string", + "format": "uri-template" }, - "deleted_by_id": { - "type": "integer" - } - } - }, - "nuget_metadata": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "object", - "integer" - ] - }, - "name": { - "type": "string" - }, - "value": { - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "branch": { - "type": "string" - }, - "commit": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - ] - } - } - } - }, - "package_files": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "md5": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "sha1": { - "type": [ - "string", - "null" - ] - }, - "sha256": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "state": { - "type": [ - "string", - "null" - ] + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } }, - "updated_at": { - "type": "string" - } + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] }, - "required": [ - "download_url", - "id", - "name", - "sha256", - "sha1", - "md5", - "content_type", - "state", - "size", - "created_at", - "updated_at" - ] - } - }, - "package_url": { - "type": "string" - }, - "prerelease": { - "type": "boolean" - }, - "release": { - "type": "object", - "properties": { - "author": { - "type": "object", + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1691816,510 +1691525,1357 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, - "created_at": { - "type": "string" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] }, - "draft": { + "private": { + "description": "Whether the repository is private or public.", "type": "boolean" }, - "html_url": { + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { "type": "string" }, - "id": { + "stargazers": { "type": "integer" }, - "name": { + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" ] }, - "prerelease": { - "type": "boolean" + "events_url": { + "type": "string", + "format": "uri-template" }, - "published_at": { + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "tag_name": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { "type": "string" }, - "target_commitish": { + "name": { + "type": "string" + }, + "node_id": { "type": "string" }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { "type": "string" } - } - }, - "rubygems_metadata": { - "type": "array", - "items": { - "title": "Ruby Gems metadata", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "readme": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "version_info": { - "type": "object", - "properties": { - "version": { - "type": "string" - } - } - }, - "platform": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repo": { - "type": "string" - }, - "dependencies": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "commit_oid": { - "type": "string" - } - } - } - }, - "summary": { - "type": "string" - }, - "tag_name": { - "type": "string" - }, - "target_commitish": { - "type": "string" - }, - "target_oid": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "version": { - "type": "string" + }, + "required": [ + "login", + "id" + ] } }, "required": [ - "id", - "version", - "name", - "description", - "summary", - "html_url", - "metadata", - "package_files", - "installation_command", - "package_url" + "label", + "ref", + "sha", + "user", + "repo" ] }, - "registry": { + "body": { "type": [ - "object", + "string", "null" - ], - "properties": { - "about_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - }, - "vendor": { - "type": "string" - } - } + ] }, - "updated_at": { + "changed_files": { + "type": "integer" + }, + "closed_at": { "type": [ "string", "null" - ] - } - }, - "required": [ - "id", - "name", - "namespace", - "description", - "ecosystem", - "package_type", - "html_url", - "created_at", - "updated_at", - "owner", - "package_version", - "registry" - ] - }, - "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 - ] + ], + "format": "date-time" }, - "node_id": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "format": "uri" }, - "name": { - "description": "The name of the repository.", + "commits": { + "type": "integer" + }, + "commits_url": { "type": "string", - "examples": [ - "Team Environment" - ] + "format": "uri" }, - "full_name": { + "created_at": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "format": "date-time" }, - "license": { - "anyOf": [ - { - "type": "null" + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], "properties": { - "key": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { "type": "string", - "examples": [ - "mit" - ] + "format": "uri-template" }, - "name": { + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { "type": "string", - "examples": [ - "MIT License" + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } ] }, - "url": { + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" ] }, - "spdx_id": { + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { "type": [ "string", "null" - ], - "examples": [ - "MIT" ] }, - "node_id": { + "hooks_url": { "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "format": "uri" }, "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": { + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { "type": [ "string", "null" ] }, - "email": { + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", "type": [ - "string", + "object", "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" ] }, - "login": { + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "type": "string", - "examples": [ - "octocat" + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" ] }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" ] }, - "node_id": { + "merges_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri" }, - "avatar_url": { + "milestones_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, - "gravatar_id": { + "mirror_url": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "format": "uri" }, - "url": { + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" ] }, - "followers_url": { + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" ] }, - "following_url": { + "releases_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" ] }, - "gists_url": { + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" ] }, - "starred_url": { + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" ] }, - "subscriptions_url": { + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "statuses_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" ] }, - "repos_url": { + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" ] }, "events_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "uri" }, - "type": { + "repos_url": { "type": "string", - "examples": [ - "User" - ] + "format": "uri" }, "site_admin": { "type": "boolean" }, - "starred_at": { + "starred_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri-template" }, - "user_view_type": { + "subscriptions_url": { "type": "string", - "examples": [ - "public" + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "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" + "id" ] } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" ] }, - "forks": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" }, "email": { "type": [ @@ -1692327,263 +1692883,1422 @@ "null" ] }, - "login": { + "events_url": { "type": "string", - "examples": [ - "octocat" - ] + "format": "uri-template" }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "following_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "login": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "name": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "node_id": { + "type": "string" }, - "subscriptions_url": { + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "received_events_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "uri" }, "type": { "type": "string", - "examples": [ - "User" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" }, "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "type": "string" } }, "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" + "id" ] }, - "description": { + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "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" - ] - }, + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, "events_url": { "type": "string", "format": "uri", @@ -1693689,7 +1695404,9 @@ }, "required": [ "action", - "registry_package", + "number", + "pull_request", + "repository", "sender" ] } @@ -1693704,7 +1695421,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -1693713,13 +1695430,12 @@ } } }, - "registry-package-updated": { + "push": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1693741,7 +1695457,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "registry_package", + "example": "push", "schema": { "type": "string" } @@ -1693784,14 +1695500,158 @@ "content": { "application/json": { "schema": { + "title": "push event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "updated" + "after": { + "description": "The SHA of the most recent commit on `ref` after the push.", + "type": "string" + }, + "base_ref": { + "type": [ + "string", + "null" ] }, + "before": { + "description": "The SHA of the most recent commit on `ref` before the push.", + "type": "string" + }, + "commits": { + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest/rest/commits) to fetch additional commits.", + "type": "array", + "items": { + "title": "Commit", + "type": "object", + "properties": { + "added": { + "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + } + }, + "compare": { + "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.", + "type": "string" + }, + "created": { + "description": "Whether this push created the `ref`.", + "type": "boolean" + }, + "deleted": { + "description": "Whether this push deleted the `ref`.", + "type": "boolean" + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", @@ -1693882,6 +1695742,132 @@ "avatar_url" ] }, + "forced": { + "description": "Whether this push was a force push of the `ref`.", + "type": "boolean" + }, + "head_commit": { + "title": "Commit", + "type": [ + "object", + "null" + ], + "properties": { + "added": { + "description": "An array of files added in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1694006,55 +1695992,406 @@ "description" ] }, - "registry_package": { + "pusher": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "ref": { + "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.", + "type": "string" + }, + "repository": { + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "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 + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string" }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, "description": { "type": [ + "string", "null" ] }, - "ecosystem": { + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { "type": "string" }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { - "type": "integer" + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, "name": { + "description": "The name of the repository.", "type": "string" }, - "namespace": { + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { "type": "string" }, "owner": { - "type": "object", + "title": "User", + "type": [ + "object", + "null" + ], "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri" }, "following_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gists_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -1694062,32 +1696399,46 @@ "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri" }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, "user_view_type": { "type": "string" @@ -1694095,30 +1696446,843 @@ }, "required": [ "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" + "id" ] }, - "package_type": { - "type": "string" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] }, - "package_version": { + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "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": [ + "ref", + "before", + "after", + "created", + "deleted", + "forced", + "base_ref", + "compare", + "commits", + "head_commit", + "repository", + "pusher" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "push", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "registry-package-published": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package" + }, + "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": "registry_package", + "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": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" + ] + }, + "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" + ] + }, + "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" + ] + }, + "registry_package": { + "type": "object", + "properties": { + "created_at": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { "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" + }, + "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": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "package_type": { + "type": "string" + }, + "package_version": { + "type": [ + "object", + "null" + ], "properties": { "author": { "type": "object", @@ -1694203,11 +1697367,46 @@ ] }, "body": { - "type": "string" + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] }, "body_html": { "type": "string" }, + "container_metadata": { + "type": "object", + "properties": { + "labels": { + "type": [ + "object", + "null" + ] + }, + "manifest": { + "type": [ + "object", + "null" + ] + }, + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, "created_at": { "type": "string" }, @@ -1694217,10 +1697416,7 @@ "docker_metadata": { "type": "array", "items": { - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "tags": { "type": "array", @@ -1694256,6 +1697452,266 @@ "name": { "type": "string" }, + "npm_metadata": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "npm_user": { + "type": "string" + }, + "author": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "bugs": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "dependencies": { + "type": "object" + }, + "dev_dependencies": { + "type": "object" + }, + "peer_dependencies": { + "type": "object" + }, + "optional_dependencies": { + "type": "object" + }, + "description": { + "type": "string" + }, + "dist": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "git_head": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "license": { + "type": "string" + }, + "main": { + "type": "string" + }, + "repository": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "scripts": { + "type": "object" + }, + "id": { + "type": "string" + }, + "node_version": { + "type": "string" + }, + "npm_version": { + "type": "string" + }, + "has_shrinkwrap": { + "type": "boolean" + }, + "maintainers": { + "type": "array", + "items": { + "type": "string" + } + }, + "contributors": { + "type": "array", + "items": { + "type": "string" + } + }, + "engines": { + "type": "object" + }, + "keywords": { + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + }, + "bin": { + "type": "object" + }, + "man": { + "type": "object" + }, + "directories": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "type": [ + "null", + "string", + "object" + ] + }, + "os": { + "type": "array", + "items": { + "type": "string" + } + }, + "cpu": { + "type": "array", + "items": { + "type": "string" + } + }, + "readme": { + "type": "string" + }, + "installation_command": { + "type": "string" + }, + "release_id": { + "type": "integer" + }, + "commit_oid": { + "type": "string" + }, + "published_via_actions": { + "type": "boolean" + }, + "deleted_by_id": { + "type": "integer" + } + } + }, + "nuget_metadata": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "object", + "integer" + ] + }, + "name": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "commit": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + ] + } + } + } + }, "package_files": { "type": "array", "items": { @@ -1694289,18 +1697745,37 @@ ] }, "sha256": { - "type": "string" + "type": [ + "string", + "null" + ] }, "size": { "type": "integer" }, "state": { - "type": "string" + "type": [ + "string", + "null" + ] }, "updated_at": { "type": "string" } - } + }, + "required": [ + "download_url", + "id", + "name", + "sha256", + "sha1", + "md5", + "content_type", + "state", + "size", + "created_at", + "updated_at" + ] } }, "package_url": { @@ -1694372,27 +1697847,7 @@ "user_view_type": { "type": "string" } - }, - "required": [ - "login", - "id", - "node_id", - "avatar_url", - "gravatar_id", - "url", - "html_url", - "followers_url", - "following_url", - "gists_url", - "starred_url", - "subscriptions_url", - "organizations_url", - "repos_url", - "events_url", - "received_events_url", - "type", - "site_admin" - ] + } }, "created_at": { "type": "string" @@ -1694407,7 +1697862,10 @@ "type": "integer" }, "name": { - "type": "string" + "type": [ + "string", + "null" + ] }, "prerelease": { "type": "boolean" @@ -1694424,20 +1697882,7 @@ "url": { "type": "string" } - }, - "required": [ - "url", - "html_url", - "id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "created_at", - "published_at" - ] + } }, "rubygems_metadata": { "type": "array", @@ -1694517,16 +1697962,9 @@ "name", "description", "summary", - "body", - "body_html", "html_url", - "target_commitish", - "target_oid", - "created_at", - "updated_at", "metadata", "package_files", - "author", "installation_command", "package_url" ] @@ -1694535,10 +1697973,30 @@ "type": [ "object", "null" - ] + ], + "properties": { + "about_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "vendor": { + "type": "string" + } + } }, "updated_at": { - "type": "string" + "type": [ + "string", + "null" + ] } }, "required": [ @@ -1696256,13 +1699714,13 @@ } } }, - "release-created": { + "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -1696284,7 +1699742,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -1696327,13 +1699785,12 @@ "content": { "application/json": { "schema": { - "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "updated" ] }, "enterprise": { @@ -1696550,232 +1700007,55 @@ "description" ] }, - "release": { - "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", + "registry_package": { "type": "object", "properties": { - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "download_count": { - "type": "integer" - }, - "id": { - "type": "integer" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ] - } - }, - "assets_url": { - "type": "string", - "format": "uri" + "created_at": { + "type": "string" }, - "author": { - "title": "User", + "description": { "type": [ - "object", "null" - ], + ] + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { + "type": "object", "properties": { "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] + "type": "string" }, "events_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "followers_url": { - "type": "string", - "format": "uri" + "type": "string" }, "following_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gists_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" @@ -1696783,46 +1700063,32 @@ "login": { "type": "string" }, - "name": { - "type": "string" - }, "node_id": { "type": "string" }, "organizations_url": { - "type": "string", - "format": "uri" + "type": "string" }, "received_events_url": { - "type": "string", - "format": "uri" + "type": "string" }, "repos_url": { - "type": "string", - "format": "uri" + "type": "string" }, "site_admin": { "type": "boolean" }, "starred_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "subscriptions_url": { - "type": "string", - "format": "uri" + "type": "string" }, "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "type": "string" }, "url": { - "type": "string", - "format": "uri" + "type": "string" }, "user_view_type": { "type": "string" @@ -1696830,502 +1700096,798 @@ }, "required": [ "login", - "id" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri" - }, - "draft": { - "description": "Whether the release is a draft or published", - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" ] }, - "node_id": { + "package_type": { "type": "string" }, - "prerelease": { - "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "reactions": { - "title": "Reactions", + "package_version": { "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" - ] - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, - "url": { - "type": "string", - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "assets_url", - "upload_url", - "html_url", - "id", - "node_id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "immutable", - "created_at", - "published_at", - "assets", - "tarball_url", - "updated_at", - "zipball_url", - "body" - ] - }, - "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", + "author": { "type": "object", "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] + "avatar_url": { + "type": "string" }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] + "events_url": { + "type": "string" }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] + "followers_url": { + "type": "string" }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "following_url": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" }, "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" - ] + "type": "string" }, - "email": { - "type": [ - "string", - "null" - ] + "id": { + "type": "integer" }, "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "type": "string" }, "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" - ] + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "organizations_url": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "received_events_url": { + "type": "string" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "repos_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "site_admin": { + "type": "boolean" }, "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "type": "string" }, "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": "string" }, "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "type": "string" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "url": { + "type": "string" }, "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "type": "string" } }, "required": [ + "login", + "id", + "node_id", "avatar_url", - "events_url", + "gravatar_id", + "url", + "html_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", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", "type", - "url" + "site_admin" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "pull": { - "type": "boolean" + "body": { + "type": "string" }, - "triage": { - "type": "boolean" + "body_html": { + "type": "string" }, - "push": { - "type": "boolean" + "created_at": { + "type": "string" }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] + "description": { + "type": "string" }, - "email": { - "type": [ - "string", - "null" - ] + "docker_metadata": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ], + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "type": "integer" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "sha1": { + "type": [ + "string", + "null" + ] + }, + "sha256": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "package_url": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "release": { + "type": "object", + "properties": { + "author": { + "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" + }, + "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": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "required": [ + "url", + "html_url", + "id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "created_at", + "published_at" + ] + }, + "rubygems_metadata": { + "type": "array", + "items": { + "title": "Ruby Gems metadata", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "readme": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "version_info": { + "type": "object", + "properties": { + "version": { + "type": "string" + } + } + }, + "platform": { + "type": "string" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repo": { + "type": "string" + }, + "dependencies": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "commit_oid": { + "type": "string" + } + } + } + }, + "summary": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "target_oid": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "required": [ + "id", + "version", + "name", + "description", + "summary", + "body", + "body_html", + "html_url", + "target_commitish", + "target_oid", + "created_at", + "updated_at", + "metadata", + "package_files", + "author", + "installation_command", + "package_url" + ] + }, + "registry": { + "type": [ + "object", + "null" + ] + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", + "created_at", + "updated_at", + "owner", + "package_version", + "registry" + ] + }, + "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": { @@ -1698671,8 +1702233,7 @@ }, "required": [ "action", - "release", - "repository", + "registry_package", "sender" ] } @@ -1698687,7 +1702248,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -1698696,11 +1702257,11 @@ } } }, - "release-deleted": { + "release-created": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, @@ -1698767,13 +1702328,13 @@ "content": { "application/json": { "schema": { - "title": "release deleted event", + "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "created" ] }, "enterprise": { @@ -1701136,11 +1704697,11 @@ } } }, - "release-edited": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "description": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, @@ -1701207,68 +1704768,15 @@ "content": { "application/json": { "schema": { - "title": "release edited event", + "title": "release deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "deleted" ] }, - "changes": { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "name": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the name if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "tag_name": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the tag_name if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "make_latest": { - "type": "object", - "properties": { - "to": { - "description": "Whether this release was explicitly `edited` to be the latest.", - "type": "boolean" - } - }, - "required": [ - "to" - ] - } - } - }, "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).\"", @@ -1703604,9 +1707112,9 @@ }, "required": [ "action", - "changes", "release", - "repository" + "repository", + "sender" ] } } @@ -1703629,11 +1707137,11 @@ } } }, - "release-prereleased": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, @@ -1703700,15 +1707208,68 @@ "content": { "application/json": { "schema": { - "title": "release prereleased event", + "title": "release edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "prereleased" + "edited" ] }, + "changes": { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "tag_name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the tag_name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "make_latest": { + "type": "object", + "properties": { + "to": { + "description": "Whether this release was explicitly `edited` to be the latest.", + "type": "boolean" + } + }, + "required": [ + "to" + ] + } + } + }, "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).\"", @@ -1703927,53 +1707488,13 @@ "title": "Release", "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", - "required": [ - "assets", - "assets_url", - "author", - "body", - "created_at", - "draft", - "html_url", - "id", - "immutable", - "name", - "node_id", - "prerelease", - "published_at", - "tag_name", - "tarball_url", - "target_commitish", - "updated_at", - "upload_url", - "url", - "zipball_url" - ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": [ - "object", - "null" - ], - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ], + "type": "object", "properties": { "browser_download_url": { "type": "string", @@ -1704031,10 +1707552,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1704119,13 +1707636,32 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "login", + "id" + ] }, "url": { "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "digest", + "content_type", + "size", + "download_count", + "created_at", + "updated_at" + ] } }, "assets_url": { @@ -1704138,10 +1707674,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1704229,7 +1707761,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": [ @@ -1704244,6 +1707780,13 @@ ], "format": "date-time" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1704274,10 +1707817,7 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean", - "enum": [ - true - ] + "type": "boolean" }, "published_at": { "type": [ @@ -1704289,18 +1707829,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1704333,7 +1707861,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "tag_name": { "description": "The name of the tag.", @@ -1704354,13 +1707894,6 @@ "type": "string", "format": "uri-template" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "url": { "type": "string", "format": "uri" @@ -1704372,7 +1707905,29 @@ ], "format": "uri" } - } + }, + "required": [ + "url", + "assets_url", + "upload_url", + "html_url", + "id", + "node_id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "immutable", + "created_at", + "published_at", + "assets", + "tarball_url", + "updated_at", + "zipball_url", + "body" + ] }, "repository": { "title": "Repository", @@ -1706050,6 +1709605,7 @@ }, "required": [ "action", + "changes", "release", "repository" ] @@ -1706074,11 +1709630,11 @@ } } }, - "release-published": { + "release-prereleased": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, @@ -1706145,13 +1709701,13 @@ "content": { "application/json": { "schema": { - "title": "release published event", + "title": "release prereleased event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "prereleased" ] }, "enterprise": { @@ -1706381,10 +1709937,10 @@ "draft", "html_url", "id", + "immutable", "name", "node_id", "prerelease", - "immutable", "published_at", "tag_name", "tarball_url", @@ -1706412,9 +1709968,9 @@ "name", "label", "state", + "digest", "content_type", "size", - "digest", "download_count", "created_at", "updated_at" @@ -1706719,7 +1710275,10 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" + "type": "boolean", + "enum": [ + true + ] }, "published_at": { "type": [ @@ -1706792,6 +1710351,10 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, "updated_at": { "type": [ "string", @@ -1706799,10 +1710362,6 @@ ], "format": "date-time" }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, "url": { "type": "string", "format": "uri" @@ -1708516,11 +1712075,11 @@ } } }, - "release-released": { + "release-published": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, @@ -1708587,13 +1712146,13 @@ "content": { "application/json": { "schema": { - "title": "release released event", + "title": "release published event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "released" + "published" ] }, "enterprise": { @@ -1708814,13 +1712373,53 @@ "title": "Release", "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", + "required": [ + "assets", + "assets_url", + "author", + "body", + "created_at", + "draft", + "html_url", + "id", + "name", + "node_id", + "prerelease", + "immutable", + "published_at", + "tag_name", + "tarball_url", + "target_commitish", + "updated_at", + "upload_url", + "url", + "zipball_url" + ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": "object", + "type": [ + "object", + "null" + ], + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], "properties": { "browser_download_url": { "type": "string", @@ -1708878,6 +1712477,10 @@ "object", "null" ], + "required": [ + "login", + "id" + ], "properties": { "avatar_url": { "type": "string", @@ -1708962,32 +1712565,13 @@ "type": "string", "format": "uri" } - }, - "required": [ - "login", - "id" - ] + } }, "url": { "type": "string", "format": "uri" } - }, - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ] + } } }, "assets_url": { @@ -1709000,6 +1712584,10 @@ "object", "null" ], + "required": [ + "login", + "id" + ], "properties": { "avatar_url": { "type": "string", @@ -1709087,11 +1712675,7 @@ "user_view_type": { "type": "string" } - }, - "required": [ - "login", - "id" - ] + } }, "body": { "type": [ @@ -1709106,13 +1712690,6 @@ ], "format": "date-time" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "discussion_url": { "type": "string", "format": "uri" @@ -1709155,6 +1712732,18 @@ "reactions": { "title": "Reactions", "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], "properties": { "+1": { "type": "integer" @@ -1709187,19 +1712776,7 @@ "type": "string", "format": "uri" } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + } }, "tag_name": { "description": "The name of the tag.", @@ -1709216,6 +1712793,13 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "upload_url": { "type": "string", "format": "uri-template" @@ -1709231,29 +1712815,7 @@ ], "format": "uri" } - }, - "required": [ - "url", - "assets_url", - "upload_url", - "html_url", - "id", - "node_id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "immutable", - "created_at", - "published_at", - "assets", - "tarball_url", - "updated_at", - "zipball_url", - "body" - ] + } }, "repository": { "title": "Repository", @@ -1710955,11 +1714517,11 @@ } } }, - "release-unpublished": { + "release-released": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release or pre-release was unpublished.", - "operationId": "release/unpublished", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, @@ -1711026,13 +1714588,13 @@ "content": { "application/json": { "schema": { - "title": "release unpublished event", + "title": "release released event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unpublished" + "released" ] }, "enterprise": { @@ -1711253,53 +1714815,13 @@ "title": "Release", "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", - "required": [ - "assets", - "assets_url", - "author", - "body", - "created_at", - "draft", - "html_url", - "id", - "name", - "node_id", - "prerelease", - "immutable", - "published_at", - "tag_name", - "tarball_url", - "target_commitish", - "updated_at", - "upload_url", - "url", - "zipball_url" - ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", - "type": [ - "object", - "null" - ], - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "content_type", - "size", - "digest", - "download_count", - "created_at", - "updated_at" - ], + "type": "object", "properties": { "browser_download_url": { "type": "string", @@ -1711357,10 +1714879,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1711445,13 +1714963,32 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "login", + "id" + ] }, "url": { "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "digest", + "content_type", + "size", + "download_count", + "created_at", + "updated_at" + ] } }, "assets_url": { @@ -1711464,10 +1715001,6 @@ "object", "null" ], - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1711555,7 +1715088,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": [ @@ -1711570,6 +1715107,13 @@ ], "format": "date-time" }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1711612,18 +1715156,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1711656,7 +1715188,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "tag_name": { "description": "The name of the tag.", @@ -1711673,13 +1715217,6 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "upload_url": { "type": "string", "format": "uri-template" @@ -1711695,7 +1715232,29 @@ ], "format": "uri" } - } + }, + "required": [ + "url", + "assets_url", + "upload_url", + "html_url", + "id", + "node_id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "immutable", + "created_at", + "published_at", + "assets", + "tarball_url", + "updated_at", + "zipball_url", + "body" + ] }, "repository": { "title": "Repository", @@ -1713397,13 +1716956,13 @@ } } }, - "repository-advisory-published": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A repository security advisory was published.", - "operationId": "repository-advisory/published", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1713425,7 +1716984,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -1713468,13 +1717027,2455 @@ "content": { "application/json": { "schema": { - "title": "Repository advisory published event", + "title": "release unpublished event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "unpublished" + ] + }, + "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" + ] + }, + "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" + ] + }, + "release": { + "title": "Release", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", + "type": "object", + "required": [ + "assets", + "assets_url", + "author", + "body", + "created_at", + "draft", + "html_url", + "id", + "name", + "node_id", + "prerelease", + "immutable", + "published_at", + "tag_name", + "tarball_url", + "target_commitish", + "updated_at", + "upload_url", + "url", + "zipball_url" + ], + "properties": { + "assets": { + "type": "array", + "items": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": [ + "object", + "null" + ], + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], + "properties": { + "browser_download_url": { + "type": "string", + "format": "uri" + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "download_count": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "label": { + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": [ + "string", + "null" + ] + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "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" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "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" + } + } + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Whether the release is a draft or published", + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "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" + } + } + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string" + }, + "tarball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + } + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "release", + "repository" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-advisory-published": { + "post": { + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_advisory", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Repository advisory published event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" ] }, "enterprise": { @@ -1741892,6 +1747893,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1745227,6 +1751271,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1748562,6 +1754649,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1749652,57 +1755782,31 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", "type": "object", "properties": { "id": { "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." + "description": "ID of the actor that can dismiss reviews." }, "type": { "type": "string", - "description": "The type of the reviewer", + "description": "The type of the actor", "enum": [ - "Team" + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" ] } }, @@ -1749712,864 +1755816,976 @@ ] } }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } - }, - { - "title": "license_compliance_scanning", - "description": "Enforce any added or changed dependencies to comply with the organization's license policy.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "license_compliance_scanning" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - } - ] - } - }, - "deleted": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, + { + "title": "license_compliance_scanning", + "description": "Enforce any added or changed dependencies to comply with the organization's license policy.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "license_compliance_scanning" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + } + ] + } + }, + "deleted": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" ] }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1751491,6 +1757707,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1752470,206 +1758729,4370 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "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" + ] + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "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" + ] + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-vulnerability-alert-create": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_vulnerability_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { - "type": "object", + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "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" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "auto_dismissed", + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1754561,7 +1764984,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1754577,23 +1765000,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1754615,7 +1765036,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -1754658,15 +1765079,199 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": [ + "string", + "null" + ] + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "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" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", @@ -1756557,6 +1767162,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1756572,21 +1767178,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1756653,13 +1767257,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1758749,11 +1769353,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1758820,13 +1769424,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1758837,9 +1769441,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1758859,12 +1769460,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": [ - "string", - "null" - ] - }, "dismiss_reason": { "type": "string" }, @@ -1758964,9 +1769559,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1759008,7 +1769600,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1760927,13 +1771520,13 @@ } } }, - "repository-vulnerability-alert-reopen": { + "secret-scanning-alert-assigned": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1760955,7 +1771548,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1760998,187 +1771591,1252 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert reopen event", + "title": "secret_scanning_alert assigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopen" + "assigned" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "email": { - "type": [ - "string", - "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" ] + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" + { + "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" + ] + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" }, - "subscriptions_url": { - "type": "string", - "format": "uri" + { + "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" + ] + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "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" ] + } + ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "anyOf": [ + { + "type": "null" }, - "url": { - "type": "string", - "format": "uri" + { + "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" + ] } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] } + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "external_identifier": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "external_reference": { + "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" ], - "format": "uri" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "fix_reason": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "fixed_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "fixed_in": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "ghsa_id": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "id": { - "type": "integer" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "number": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "severity": { - "type": "string" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "state": { + "repos_url": { "type": "string", - "enum": [ - "auto_dismissed", - "open" + "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" + ] }, "enterprise": { "title": "Enterprise", @@ -1763071,8 +1774729,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1763086,21 +1774743,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1763122,7 +1774780,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1763165,185 +1774823,1082 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "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" ] - }, - "url": { - "type": "string", - "format": "uri" } - } + ] }, - "external_identifier": { - "type": "string" + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." }, - "external_reference": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { "type": [ "string", "null" ], - "format": "uri" + "description": "The provider of the secret that was detected." }, - "fix_reason": { - "type": "string" + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." }, - "fixed_at": { + "validity": { "type": "string", - "format": "date-time" + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "fixed_in": { - "type": "string" + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." }, - "ghsa_id": { - "type": "string" + "push_protection_bypassed_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" + ] + } + ] }, - "id": { - "type": "integer" + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, - "node_id": { - "type": "string" + "push_protection_bypass_request_reviewer": { + "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" + ] + } + ] }, - "number": { - "type": "integer" + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "severity": { - "type": "string" + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "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" + ] + } ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1765238,8 +1777793,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1765253,21 +1777807,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-assigned": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was assigned.", - "operationId": "secret-scanning-alert/assigned", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1765289,7 +1777844,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "secret_scanning_alert_location", "schema": { "type": "string" } @@ -1765332,13 +1777887,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert assigned event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "assigned" + "created" ] }, "alert": { @@ -1766386,291 +1778941,475 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", + "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": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "The ID of the installation.", "type": "integer", - "format": "int64", "examples": [ 1 ] }, "node_id": { + "description": "The global node ID of the installation.", "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" + "MDQ6VXNlcjU4MzIzMQ==" ] } }, "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" + "node_id" ] }, - "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).\"", + "location": { "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": { "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" ], - "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", + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", "examples": [ - 1 + "commit" ] }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "examples": [ + "/example/secrets.txt" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": [ + "/example/Home.md" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082" + ] + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussion-4566270" + ] + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + ] + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } ] } - }, - "required": [ - "id", - "node_id" - ] + } }, "organization": { "title": "Organization Simple", @@ -1768446,10 +1781185,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1768461,8 +1781375,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1768471,11 +1781386,11 @@ } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-metadata-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "description": "Metadata was created for a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1768542,13 +1781457,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "secret_scanning_alert metadata created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_created" ] }, "alert": { @@ -1769197,405 +1782112,427 @@ } ] }, - "push_protection_bypass_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when reviewing a push protection bypass." - }, - "push_protection_bypass_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when requesting a push protection bypass." - }, - "push_protection_bypass_request_html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was publicly leaked." - }, - "multi_repo": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or business." - }, - "assigned_to": { - "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" - ] - } + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "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" + ] + } + ] + }, + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." }, - "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" - ] - } - ] - }, - "closure_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request author." - }, - "closure_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request reviewer." - }, - "closure_request_reviewer": { - "anyOf": [ - { - "type": "null" + "value": { + "type": "string", + "description": "The metadata value." + } }, - { - "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": [ + "key", + "value" + ] + } } } }, @@ -1771502,7 +1784439,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -1771513,13 +1784449,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-metadata-removed": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "Metadata was removed from a secret scanning alert.", + "operationId": "secret-scanning-alert/metadata-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1771541,7 +1784477,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert_location", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1771584,13 +1784520,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert metadata removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "metadata_removed" ] }, "alert": { @@ -1772638,453 +1785574,145 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, - "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).\"", + "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": "The ID of the installation.", + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { - "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "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" + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, - "location": { + "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": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "commit" + 1 ] }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/example/secrets.txt" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL to get the associated commit resource.", - "examples": [ - "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "examples": [ - "/example/Home.md" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1" - ] - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1" - ] - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the issue comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" - ] - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082" - ] - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussion-4566270" - ] - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846" - ] - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846" - ] - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" - ] - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request review where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" - ] - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The GitHub URL for the pull request review comment where the secret was detected.", - "examples": [ - "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" ] } - } + }, + "required": [ + "id", + "node_id" + ] }, "organization": { "title": "Organization Simple", @@ -1774860,185 +1787488,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1775049,10 +1787502,8 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1776186,6 +1788637,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1779040,194 +1791513,216 @@ } ] }, - "closure_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request author." - }, - "closure_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment from the closure request reviewer." - }, - "closure_request_reviewer": { - "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" - ] - } + "closure_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request author." + }, + "closure_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment from the closure request reviewer." + }, + "closure_request_reviewer": { + "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" + ] + } + ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." }, - "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" - ] - } - ] + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1782270,6 +1794765,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1785312,6 +1797829,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, @@ -1788522,6 +1801061,28 @@ ] } ] + }, + "metadata": { + "type": "array", + "description": "A list of metadata key/value pairs associated with the secret scanning alert.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The metadata key." + }, + "value": { + "type": "string", + "description": "The metadata value." + } + }, + "required": [ + "key", + "value" + ] + } } } }, diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 3f358d5b70..e19851ff81 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -922,7 +922,7 @@ paths: - subscriptions_url - type - url - type: &456 + type: &458 type: string description: The type of credit the user is receiving. enum: @@ -1088,7 +1088,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &777 + - &779 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -4361,7 +4361,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &786 + schema: &788 title: Scim Error description: Scim Error type: object @@ -12016,7 +12016,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &787 + '401': &789 description: Authorization failure '404': *6 x-github: @@ -16301,7 +16301,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &544 + instances_url: &546 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -16337,7 +16337,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &545 + dismissed_reason: &547 type: - string - 'null' @@ -16348,14 +16348,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &546 + dismissed_comment: &548 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &547 + rule: &549 type: object properties: id: @@ -16416,7 +16416,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &548 + tool: &550 type: object properties: name: *111 @@ -16427,26 +16427,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *112 - most_recent_instance: &549 + most_recent_instance: &551 type: object properties: - ref: &542 + ref: &544 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &559 + analysis_key: &561 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: &560 + environment: &562 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: &561 + category: &563 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -16466,7 +16466,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &562 + location: &564 type: object description: Describe a region within a file for the alert. properties: @@ -16487,7 +16487,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: &563 + items: &565 type: - string - 'null' @@ -20919,7 +20919,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 - - &602 + - &604 name: has in: query description: |- @@ -21046,7 +21046,7 @@ paths: - transitive - inconclusive - - security_advisory: &603 + security_advisory: &605 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -21289,7 +21289,7 @@ paths: dismissal. maxLength: 280 fixed_at: *140 - auto_dismissed_at: &604 + auto_dismissed_at: &606 type: - string - 'null' @@ -21297,7 +21297,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &605 + dismissal_request: &607 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -22843,144 +22843,152 @@ paths: content: application/json: schema: - type: array - description: Array of vulnerabilities in OSV format to synchronize - items: - title: OSV Vulnerability - description: A vulnerability in OSV (Open Source Vulnerability) format - type: object - required: - - id - properties: - id: - type: string - description: Unique identifier for the vulnerability from the - external system - examples: - - MVS-2026-001 - schema_version: - type: string - description: The OSV schema version - examples: - - 1.4.0 - summary: - type: string - description: A short summary of the vulnerability - examples: - - Example vulnerability summary - details: - type: string - description: Detailed description of the vulnerability - aliases: - type: array - description: IDs for the same vulnerability in other databases. - Only CVE IDs are used (to populate the vulnerability's CVE identifier); - other aliases are ignored. - items: - type: string - examples: - - CVE-2026-12345 - severity: - type: array - description: Severity information for the vulnerability - items: - type: object - properties: - type: - type: string - description: The type of severity scoring (e.g., CVSS_V3) - score: + type: object + required: + - vulnerabilities + properties: + vulnerabilities: + type: array + description: Array of vulnerabilities in OSV format to synchronize + items: + title: OSV Vulnerability + description: A vulnerability in OSV (Open Source Vulnerability) + format + type: object + required: + - id + properties: + id: + type: string + description: Unique identifier for the vulnerability from + the external system + examples: + - MVS-2026-001 + schema_version: + type: string + description: The OSV schema version + examples: + - 1.4.0 + summary: + type: string + description: A short summary of the vulnerability + examples: + - Example vulnerability summary + details: + type: string + description: Detailed description of the vulnerability + aliases: + type: array + description: IDs for the same vulnerability in other databases. + Only CVE IDs are used (to populate the vulnerability's CVE + identifier); other aliases are ignored. + items: type: string - description: The severity score or vector string - affected: - type: array - description: Packages and versions affected by the vulnerability - items: - type: object - properties: - package: + examples: + - CVE-2026-12345 + severity: + type: array + description: Severity information for the vulnerability + items: type: object properties: - ecosystem: + type: type: string - description: The package ecosystem (e.g., npm, pip, - maven) - name: + description: The type of severity scoring (e.g., CVSS_V3) + score: type: string - description: The package name - ranges: - type: array - items: - type: object - properties: - type: - type: string - events: - type: array - items: - type: object - properties: - introduced: - type: string - description: The version that introduced the - vulnerability - fixed: - type: string - description: The version that fixed the vulnerability - last_affected: - type: string - description: The last affected version - limit: - type: string - description: The upper limit of the affected - range - references: - type: array - description: URLs for more information about the vulnerability - items: - type: object - properties: - type: - type: string - description: 'The type of reference. Supported values: PACKAGE, - ADVISORY, WEB, FIX, ARTICLE, REPORT, EVIDENCE. References - with other types are ignored.' - url: - type: string - format: uri - description: The reference URL - published: - type: string - format: date-time - description: When the vulnerability was first published - modified: - type: string - format: date-time - description: When the vulnerability was last modified - withdrawn: - type: string - format: date-time - description: When the vulnerability was withdrawn. If present, - the vulnerability will be marked as withdrawn. - minItems: 1 - maxItems: 100 + description: The severity score or vector string + affected: + type: array + description: Packages and versions affected by the vulnerability + items: + type: object + properties: + package: + type: object + properties: + ecosystem: + type: string + description: The package ecosystem (e.g., npm, pip, + maven) + name: + type: string + description: The package name + ranges: + type: array + items: + type: object + properties: + type: + type: string + events: + type: array + items: + type: object + properties: + introduced: + type: string + description: The version that introduced + the vulnerability + fixed: + type: string + description: The version that fixed the + vulnerability + last_affected: + type: string + description: The last affected version + limit: + type: string + description: The upper limit of the affected + range + references: + type: array + description: URLs for more information about the vulnerability + items: + type: object + properties: + type: + type: string + description: 'The type of reference. Supported values: + PACKAGE, ADVISORY, WEB, FIX, ARTICLE, REPORT, EVIDENCE. + References with other types are ignored.' + url: + type: string + format: uri + description: The reference URL + published: + type: string + format: date-time + description: When the vulnerability was first published + modified: + type: string + format: date-time + description: When the vulnerability was last modified + withdrawn: + type: string + format: date-time + description: When the vulnerability was withdrawn. If present, + the vulnerability will be marked as withdrawn. + minItems: 1 + maxItems: 100 examples: default: value: - - id: MVS-2026-001 - schema_version: 1.4.0 - summary: Example vulnerability summary - aliases: - - GHSA-xxxx-xxxx-xxxx - affected: - - package: - ecosystem: npm - name: example-package - ranges: - - type: SEMVER - events: - - introduced: 1.0.0 - - fixed: 1.0.1 + vulnerabilities: + - id: MVS-2026-001 + schema_version: 1.4.0 + summary: Example vulnerability summary + aliases: + - GHSA-xxxx-xxxx-xxxx + affected: + - package: + ecosystem: npm + name: example-package + ranges: + - type: SEMVER + events: + - introduced: 1.0.0 + - fixed: 1.0.1 responses: '202': description: Sync operation accepted for asynchronous processing. Poll the @@ -23498,7 +23506,7 @@ paths: - name - created_on examples: - default: &460 + default: &462 value: total_count: 2 network_configurations: @@ -23749,7 +23757,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 - - &461 + - &463 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -23761,7 +23769,7 @@ paths: description: Response content: application/json: - schema: &462 + schema: &464 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -23800,7 +23808,7 @@ paths: - subnet_id - region examples: - default: &463 + default: &465 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -25214,6 +25222,43 @@ paths: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + title: DismissalRestriction + description: Specify people, teams, or apps allowed + to dismiss pull request reviews. + type: object + properties: + allowed_actors: + type: array + description: Specify people, teams, or apps allowed + to dismiss pull request reviews. + items: + title: Actor + description: An actor allowed to dismiss pull + request reviews + type: object + properties: + id: + type: integer + description: ID of the actor that can dismiss + reviews. + type: + type: string + description: The type of the actor + enum: + - User + - Team + - IntegrationInstallation + - RepositoryRole + required: + - id + - type + enabled: + type: boolean + description: Whether to restrict review dismissal + to specific actors. + required: + - enabled require_code_owner_review: type: boolean description: Require an approving review in pull requests @@ -25907,7 +25952,7 @@ paths: - object rules: type: array - items: &742 + items: &744 title: Repository Rule type: object description: A repository rule. @@ -25916,7 +25961,7 @@ paths: - *170 - *171 - *172 - - &739 + - &741 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -26007,7 +26052,7 @@ paths: - *183 - *184 - *185 - - &740 + - &742 title: license_compliance_scanning description: Enforce any added or changed dependencies to comply with the organization's license policy. @@ -26509,6 +26554,29 @@ paths: required: false schema: type: boolean + - &452 + name: included_metadata + in: query + description: |- + A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the + specified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`, + `owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`, + `organization-id`, `last-used-date`, and `has-organization-access`. + required: false + schema: + type: string + - &453 + name: owner_email_hash + in: query + description: |- + Filters alerts to only those whose attached `owner_email` metadata field matches the + provided value. The value must be the lowercase hex-encoded SHA-256 hash of the email + address to match (for example, the SHA-256 of `user@example.com`). Only alerts that + have an `owner_email` metadata value whose SHA-256 hash equals this parameter are + returned. + required: false + schema: + type: string responses: '200': description: Response @@ -26516,7 +26584,7 @@ paths: application/json: schema: type: array - items: &452 + items: &454 type: object properties: number: *130 @@ -26532,14 +26600,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &755 + state: &757 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &756 + resolution: &758 type: - string - 'null' @@ -26658,14 +26726,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &757 + - &759 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &759 + - &761 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -26729,7 +26797,7 @@ paths: - blob_url - commit_sha - commit_url - - &760 + - &762 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -26790,7 +26858,7 @@ paths: - page_url - commit_sha - commit_url - - &761 + - &763 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -26812,7 +26880,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &762 + - &764 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -26834,7 +26902,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &763 + - &765 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -26856,7 +26924,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &764 + - &766 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -26871,7 +26939,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &765 + - &767 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -26886,7 +26954,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &766 + - &768 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -26901,7 +26969,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &767 + - &769 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -26923,7 +26991,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &768 + - &770 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -26945,7 +27013,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &769 + - &771 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -26967,7 +27035,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &770 + - &772 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -26989,7 +27057,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &771 + - &773 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -27035,7 +27103,7 @@ paths: - type: 'null' - *4 examples: - default: &453 + default: &455 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -27244,7 +27312,7 @@ paths: description: Response content: application/json: - schema: &454 + schema: &456 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -27331,7 +27399,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *196 examples: - default: &455 + default: &457 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -27467,7 +27535,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 - - &457 + - &459 name: advanced_security_product in: query description: | @@ -27487,7 +27555,7 @@ paths: description: Success content: application/json: - schema: &458 + schema: &460 type: object properties: total_advanced_security_committers: @@ -27550,7 +27618,7 @@ paths: required: - repositories examples: - default: &459 + default: &461 value: total_advanced_security_committers: 2 total_count: 2 @@ -31233,7 +31301,7 @@ paths: properties: action: type: string - discussion: &895 + discussion: &897 title: Discussion description: A Discussion in a repository. type: object @@ -32019,7 +32087,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &814 + sub_issues_summary: &816 title: Sub-issues Summary type: object properties: @@ -32103,7 +32171,7 @@ paths: pin: anyOf: - type: 'null' - - &686 + - &688 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -32124,7 +32192,7 @@ paths: minimized: anyOf: - type: 'null' - - &687 + - &689 title: Minimized Issue Comment description: Details about why an issue comment was minimized. @@ -32149,7 +32217,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &815 + issue_dependencies_summary: &817 title: Issue Dependencies Summary type: object properties: @@ -32168,7 +32236,7 @@ paths: - total_blocking issue_field_values: type: array - items: &670 + items: &672 title: Issue Field Value description: A value assigned to an issue field type: object @@ -32985,7 +33053,7 @@ paths: type: string release: allOf: - - &732 + - &734 title: Release description: A release. type: object @@ -33067,7 +33135,7 @@ paths: author: *4 assets: type: array - items: &733 + items: &735 title: Release Asset description: Data related to a release. type: object @@ -33658,7 +33726,7 @@ paths: url: type: string format: uri - user: &823 + user: &825 title: Public User description: Public User type: object @@ -37023,14 +37091,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: - - &472 + - &474 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &473 + - &475 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -37092,7 +37160,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &478 + '301': &480 description: Moved permanently content: application/json: @@ -37114,7 +37182,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &706 + - &708 name: all description: If `true`, show notifications marked as read. in: query @@ -37122,7 +37190,7 @@ paths: schema: type: boolean default: false - - &707 + - &709 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -37132,7 +37200,7 @@ paths: type: boolean default: false - *226 - - &708 + - &710 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -37733,7 +37801,7 @@ paths: - url - subscription_url examples: - default: &709 + default: &711 value: - id: '1' repository: @@ -38596,7 +38664,7 @@ paths: type: array items: *155 examples: - default: &715 + default: &717 value: - property_name: environment value: production @@ -38646,7 +38714,7 @@ paths: required: - properties examples: - default: &716 + default: &718 value: properties: - property_name: environment @@ -39537,7 +39605,7 @@ paths: type: integer repository_cache_usages: type: array - items: &485 + items: &487 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -45402,12 +45470,12 @@ paths: required: - subject_digests examples: - default: &855 + default: &857 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &856 + withPredicateType: &858 value: subject_digests: - sha256:abc123 @@ -45466,7 +45534,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &857 + default: &859 value: attestations_subject_digests: - sha256:abc: @@ -45817,7 +45885,7 @@ paths: initiator: type: string examples: - default: &518 + default: &520 value: attestations: - bundle: @@ -46739,7 +46807,7 @@ paths: be returned. in: query required: false - schema: &543 + schema: &545 type: string description: Severity of a code scanning alert. enum: @@ -47840,7 +47908,7 @@ paths: machine: anyOf: - type: 'null' - - &575 + - &577 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -48792,7 +48860,7 @@ paths: - updated_at - visibility examples: - default: &576 + default: &578 value: total_count: 2 secrets: @@ -48830,7 +48898,7 @@ paths: description: Response content: application/json: - schema: &577 + schema: &579 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -48865,7 +48933,7 @@ paths: - key_id - key examples: - default: &578 + default: &580 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -48897,7 +48965,7 @@ paths: application/json: schema: *327 examples: - default: &580 + default: &582 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -53013,7 +53081,7 @@ paths: description: Response content: application/json: - schema: &608 + schema: &610 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -53032,7 +53100,7 @@ paths: - key_id - key examples: - default: &609 + default: &611 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -53360,7 +53428,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *87 - - &618 + - &620 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -53368,7 +53436,7 @@ paths: required: false schema: type: string - - &619 + - &621 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -53376,7 +53444,7 @@ paths: required: false schema: type: string - - &620 + - &622 name: time_period description: |- The time period to filter by. @@ -53392,7 +53460,7 @@ paths: - week - month default: month - - &621 + - &623 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -53417,7 +53485,7 @@ paths: application/json: schema: type: array - items: &622 + items: &624 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -53580,7 +53648,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &623 + default: &625 value: - id: 21 number: 42 @@ -53682,7 +53750,7 @@ paths: application/json: schema: type: array - items: &624 + items: &626 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -53805,7 +53873,7 @@ paths: examples: - https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &625 + default: &627 value: - id: 21 number: 42 @@ -54193,7 +54261,7 @@ paths: description: Response content: application/json: - schema: &469 + schema: &471 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -54283,7 +54351,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &470 + default: &472 value: group_id: '123' group_name: Octocat admins @@ -54338,7 +54406,7 @@ paths: description: Response content: application/json: - schema: &466 + schema: &468 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -54378,7 +54446,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &467 + default: &469 value: groups: - group_id: '123' @@ -55890,7 +55958,7 @@ paths: required: true content: application/json: - schema: &654 + schema: &656 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -56717,7 +56785,7 @@ paths: type: array items: *386 examples: - default: &658 + default: &660 value: - id: 410 node_id: IT_kwDNAd3NAZo @@ -57246,7 +57314,7 @@ paths: application/json: schema: *391 examples: - default: &574 + default: &576 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -58508,7 +58576,7 @@ paths: parameters: - *87 - *397 - - &838 + - &840 name: repo_name description: repo_name parameter in: path @@ -59856,7 +59924,7 @@ paths: - nuget - container - *87 - - &839 + - &841 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -59897,7 +59965,7 @@ paths: default: *402 '403': *27 '401': *23 - '400': &841 + '400': &843 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -62028,7 +62096,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &928 + - &930 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -62302,7 +62370,7 @@ paths: content: oneOf: - *221 - - &589 + - &591 title: Pull Request Simple description: Pull Request Simple type: object @@ -62541,7 +62609,7 @@ paths: - review_comment - self author_association: *218 - auto_merge: &718 + auto_merge: &720 title: Auto merge description: The status of auto merging a pull request. type: @@ -62926,7 +62994,7 @@ paths: - updated_at - project_url examples: - default: &861 + default: &863 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -63103,7 +63171,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &862 + items: &864 type: object properties: name: @@ -63140,7 +63208,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &863 + iteration_configuration: &865 type: object description: The configuration for iteration fields. properties: @@ -63190,7 +63258,7 @@ paths: value: name: Due date data_type: date - single_select_field: &864 + single_select_field: &866 summary: Create a single select field value: name: Priority @@ -63217,7 +63285,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &865 + iteration_field: &867 summary: Create an iteration field value: name: Sprint @@ -63243,7 +63311,7 @@ paths: application/json: schema: *422 examples: - text_field: &866 + text_field: &868 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -63252,7 +63320,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &867 + number_field: &869 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -63261,7 +63329,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &868 + date_field: &870 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -63270,7 +63338,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &869 + single_select_field: &871 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -63304,7 +63372,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &870 + iteration_field: &872 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -63350,7 +63418,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-organization parameters: - *419 - - &871 + - &873 name: field_id description: The unique identifier of the field. in: path @@ -63365,7 +63433,7 @@ paths: application/json: schema: *422 examples: - default: &872 + default: &874 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -64576,7 +64644,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &852 + schema: &854 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -64759,7 +64827,7 @@ paths: parameters: - *419 - *87 - - &873 + - &875 name: view_number description: The number that identifies the project view. in: path @@ -65529,7 +65597,7 @@ paths: description: Response content: application/json: - schema: &477 + schema: &479 title: Full Repository description: Full Repository type: object @@ -66007,7 +66075,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &594 + code_of_conduct: &596 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -66121,7 +66189,7 @@ paths: - network_count - subscribers_count examples: - default: &479 + default: &481 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -66674,7 +66742,7 @@ paths: - *87 - *17 - *19 - - &741 + - &743 name: targets description: | A comma-separated list of rule targets to filter by. @@ -66891,7 +66959,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *87 - - &743 + - &745 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -66903,14 +66971,14 @@ paths: x-multi-segment: true - *310 - *105 - - &744 + - &746 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &745 + - &747 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -66923,7 +66991,7 @@ paths: - bypass - all default: all - - &746 + - &748 name: evaluate_status description: |- The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned. @@ -66946,7 +67014,7 @@ paths: description: Response content: application/json: - schema: &747 + schema: &749 title: Rule Suites description: Response type: array @@ -67002,7 +67070,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &748 + default: &750 value: - id: 21 actor_id: 12 @@ -67046,7 +67114,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *87 - - &749 + - &751 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -67062,7 +67130,7 @@ paths: description: Response content: application/json: - schema: &750 + schema: &752 title: Rule Suite description: Response type: object @@ -67169,7 +67237,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &751 + default: &753 value: id: 21 actor_id: 12 @@ -67505,7 +67573,7 @@ paths: - *110 - *19 - *17 - - &753 + - &755 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -67515,7 +67583,7 @@ paths: required: false schema: type: string - - &754 + - &756 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -67530,6 +67598,8 @@ paths: - *449 - *450 - *451 + - *452 + - *453 responses: '200': description: Response @@ -67537,9 +67607,9 @@ paths: application/json: schema: type: array - items: *452 + items: *454 examples: - default: *453 + default: *455 headers: Link: *45 '404': *6 @@ -67574,9 +67644,9 @@ paths: description: Response content: application/json: - schema: *454 + schema: *456 examples: - default: *455 + default: *457 '403': *27 '404': *6 patch: @@ -67729,7 +67799,7 @@ paths: application/json: schema: type: array - items: &775 + items: &777 description: A repository security advisory. type: object properties: @@ -67973,7 +68043,7 @@ paths: login: type: string description: The username of the user credited. - type: *456 + type: *458 credits_detailed: type: - array @@ -67984,7 +68054,7 @@ paths: type: object properties: user: *4 - type: *456 + type: *458 state: type: string description: The state of the user's acceptance of the @@ -68048,7 +68118,7 @@ paths: - private_fork additionalProperties: false examples: - default: &776 + default: &778 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -68534,7 +68604,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *87 - - *457 + - *459 - *17 - *19 responses: @@ -68542,9 +68612,9 @@ paths: description: Success content: application/json: - schema: *458 + schema: *460 examples: - default: *459 + default: *461 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -68827,7 +68897,7 @@ paths: type: array items: *148 examples: - default: *460 + default: *462 headers: Link: *45 x-github: @@ -69056,15 +69126,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: - *87 - - *461 + - *463 responses: '200': description: Response content: application/json: - schema: *462 + schema: *464 examples: - default: *463 + default: *465 headers: Link: *45 x-github: @@ -69102,7 +69172,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &476 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -69154,7 +69224,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &475 + default: &477 value: groups: - group_id: '123' @@ -69305,7 +69375,7 @@ paths: description: Response content: application/json: - schema: &464 + schema: &466 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -69704,7 +69774,7 @@ paths: - repos_count - organization examples: - default: &465 + default: &467 value: id: 1 node_id: MDQ6VGVhbTE= @@ -69781,9 +69851,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *466 examples: - default: *465 + default: *467 '404': *6 x-github: githubCloudOnly: false @@ -69868,16 +69938,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *464 + schema: *466 examples: - default: *465 + default: *467 '201': description: Response content: application/json: - schema: *464 + schema: *466 examples: - default: *465 + default: *467 '404': *6 '422': *15 '403': *27 @@ -69907,7 +69977,7 @@ paths: responses: '204': description: Response - '422': &468 + '422': &470 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -69936,10 +70006,10 @@ paths: description: Response content: application/json: - schema: *466 + schema: *468 examples: - default: *467 - '422': *468 + default: *469 + '422': *470 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -69983,10 +70053,10 @@ paths: description: Response content: application/json: - schema: *469 + schema: *471 examples: - default: *470 - '422': *468 + default: *472 + '422': *470 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -70010,7 +70080,7 @@ paths: responses: '204': description: Response - '422': *468 + '422': *470 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -70047,7 +70117,7 @@ paths: default: *381 headers: Link: *45 - '422': *468 + '422': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70091,7 +70161,7 @@ paths: application/json: schema: type: array - items: &817 + items: &819 title: Team Member description: A user that is a member of a team, including their role on the team and whether the membership is inherited from @@ -70234,7 +70304,7 @@ paths: - type - url examples: - default: &818 + default: &820 value: - login: octocat id: 1 @@ -70293,7 +70363,7 @@ paths: description: Response content: application/json: - schema: &471 + schema: &473 title: Team Membership description: Team Membership type: object @@ -70321,7 +70391,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &819 + response-if-user-is-a-team-maintainer: &821 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -70384,9 +70454,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *473 examples: - response-if-users-membership-with-team-is-now-pending: &820 + response-if-users-membership-with-team-is-now-pending: &822 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -70493,14 +70563,14 @@ paths: parameters: - *87 - *216 - - *472 - - *473 + - *474 + - *475 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &821 + schema: &823 title: Team Repository description: A team's access to a repository. type: object @@ -71143,8 +71213,8 @@ paths: parameters: - *87 - *216 - - *472 - - *473 + - *474 + - *475 requestBody: required: false content: @@ -71191,8 +71261,8 @@ paths: parameters: - *87 - *216 - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -71225,10 +71295,10 @@ paths: description: Response content: application/json: - schema: *474 + schema: *476 examples: - default: *475 - '422': *468 + default: *477 + '422': *470 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -71294,7 +71364,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *476 examples: default: value: @@ -71306,7 +71376,7 @@ paths: group_name: Octocat docs members group_description: The people who make your octoworld come to life. - '422': *468 + '422': *470 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -71340,7 +71410,7 @@ paths: type: array items: *313 examples: - response-if-child-teams-exist: &822 + response-if-child-teams-exist: &824 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -71493,7 +71563,7 @@ paths: resources: type: object properties: - core: &476 + core: &478 title: Rate Limit type: object properties: @@ -71510,21 +71580,21 @@ paths: - remaining - reset - used - graphql: *476 - search: *476 - code_search: *476 - source_import: *476 - integration_manifest: *476 - actions_runner_registration: *476 - scim: *476 - dependency_snapshots: *476 - dependency_sbom: *476 - code_scanning_autofix: *476 - copilot_usage_records: *476 + graphql: *478 + search: *478 + code_search: *478 + source_import: *478 + integration_manifest: *478 + actions_runner_registration: *478 + scim: *478 + dependency_snapshots: *478 + dependency_sbom: *478 + code_scanning_autofix: *478 + copilot_usage_records: *478 required: - core - search - rate: *476 + rate: *478 required: - rate - resources @@ -71624,14 +71694,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response content: application/json: - schema: *477 + schema: *479 examples: default-response: summary: Default response @@ -72140,7 +72210,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *478 + '301': *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72158,8 +72228,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#update-a-repository parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: false content: @@ -72480,10 +72550,10 @@ paths: description: Response content: application/json: - schema: *477 + schema: *479 examples: - default: *479 - '307': &480 + default: *481 + '307': &482 description: Temporary Redirect content: application/json: @@ -72512,8 +72582,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -72535,7 +72605,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': *480 + '307': *482 '404': *6 '409': *119 x-github: @@ -72559,11 +72629,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 - - &496 + - &498 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -72586,7 +72656,7 @@ paths: type: integer artifacts: type: array - items: &481 + items: &483 title: Artifact description: An artifact type: object @@ -72681,7 +72751,7 @@ paths: - expires_at - updated_at examples: - default: &497 + default: &499 value: total_count: 2 artifacts: @@ -72742,9 +72812,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#get-an-artifact parameters: - - *472 - - *473 - - &482 + - *474 + - *475 + - &484 name: artifact_id description: The unique identifier of the artifact. in: path @@ -72756,7 +72826,7 @@ paths: description: Response content: application/json: - schema: *481 + schema: *483 examples: default: value: @@ -72794,9 +72864,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#delete-an-artifact parameters: - - *472 - - *473 - - *482 + - *474 + - *475 + - *484 responses: '204': description: Response @@ -72820,9 +72890,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#download-an-artifact parameters: - - *472 - - *473 - - *482 + - *474 + - *475 + - *484 - name: archive_format in: path required: true @@ -72832,11 +72902,11 @@ paths: '302': description: Response headers: - Location: &611 + Location: &613 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &659 + '410': &661 description: Gone content: application/json: @@ -72861,14 +72931,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response content: application/json: - schema: &483 + schema: &485 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -72902,13 +72972,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: application/json: - schema: *483 + schema: *485 examples: selected_actions: *42 responses: @@ -72937,14 +73007,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response content: application/json: - schema: &484 + schema: &486 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -72978,13 +73048,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: application/json: - schema: *484 + schema: *486 examples: selected_actions: *44 responses: @@ -73015,14 +73085,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response content: application/json: - schema: *485 + schema: *487 examples: default: value: @@ -73048,11 +73118,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: - - *472 - - *473 + - *474 + - *475 - *17 - *19 - - &486 + - &488 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 @@ -73086,7 +73156,7 @@ paths: description: Response content: application/json: - schema: &487 + schema: &489 title: Repository actions caches description: Repository actions caches type: object @@ -73136,7 +73206,7 @@ paths: - total_count - actions_caches examples: - default: &488 + default: &490 value: total_count: 1 actions_caches: @@ -73168,23 +73238,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: - - *472 - - *473 + - *474 + - *475 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *486 + - *488 responses: '200': description: Response content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73204,8 +73274,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: - - *472 - - *473 + - *474 + - *475 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -73234,8 +73304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *109 responses: @@ -73318,8 +73388,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 - name: concurrency_group_name description: The name of the concurrency group. in: path @@ -73475,9 +73545,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: - - *472 - - *473 - - &489 + - *474 + - *475 + - &491 name: job_id description: The unique identifier of the job. in: path @@ -73489,7 +73559,7 @@ paths: description: Response content: application/json: - schema: &500 + schema: &502 title: Job description: Information of a job execution in a workflow run type: object @@ -73836,9 +73906,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: - - *472 - - *473 - - *489 + - *474 + - *475 + - *491 responses: '302': description: Response @@ -73866,9 +73936,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: - - *472 - - *473 - - *489 + - *474 + - *475 + - *491 requestBody: required: false content: @@ -73919,8 +73989,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Status response @@ -73979,8 +74049,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -74048,8 +74118,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-organization-secrets parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -74067,7 +74137,7 @@ paths: type: integer secrets: type: array - items: &502 + items: &504 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -74088,7 +74158,7 @@ paths: - created_at - updated_at examples: - default: &503 + default: &505 value: total_count: 2 secrets: @@ -74121,8 +74191,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-organization-variables parameters: - - *472 - - *473 + - *474 + - *475 - *299 - *19 responses: @@ -74140,7 +74210,7 @@ paths: type: integer variables: type: array - items: &504 + items: &506 title: Actions Variable type: object properties: @@ -74174,7 +74244,7 @@ paths: - created_at - updated_at examples: - default: &505 + default: &507 value: total_count: 2 variables: @@ -74207,8 +74277,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -74217,7 +74287,7 @@ paths: schema: type: object properties: - enabled: &490 + enabled: &492 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *60 @@ -74252,8 +74322,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: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -74264,7 +74334,7 @@ paths: schema: type: object properties: - enabled: *490 + enabled: *492 allowed_actions: *60 sha_pinning_required: *61 required: @@ -74297,14 +74367,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response content: application/json: - schema: &491 + schema: &493 type: object properties: access_level: @@ -74322,7 +74392,7 @@ paths: required: - access_level examples: - default: &492 + default: &494 value: access_level: organization x-github: @@ -74347,15 +74417,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: application/json: - schema: *491 + schema: *493 examples: - default: *492 + default: *494 responses: '204': description: Response @@ -74379,8 +74449,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -74410,8 +74480,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: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Empty response for successful settings update @@ -74445,8 +74515,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -74473,8 +74543,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: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -74508,8 +74578,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -74537,8 +74607,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -74569,8 +74639,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -74601,8 +74671,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: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -74634,8 +74704,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -74664,8 +74734,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: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Success response @@ -74705,8 +74775,8 @@ paths: in: query schema: type: string - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -74750,8 +74820,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -74783,8 +74853,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -74858,8 +74928,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: - - *472 - - *473 + - *474 + - *475 responses: '201': description: Response @@ -74895,8 +74965,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: - - *472 - - *473 + - *474 + - *475 responses: '201': description: Response @@ -74926,8 +74996,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: - - *472 - - *473 + - *474 + - *475 - *75 responses: '200': @@ -74957,8 +75027,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: - - *472 - - *473 + - *474 + - *475 - *75 responses: '204': @@ -74985,8 +75055,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: - - *472 - - *473 + - *474 + - *475 - *75 responses: '200': *81 @@ -75011,8 +75081,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: - - *472 - - *473 + - *474 + - *475 - *75 requestBody: required: true @@ -75061,8 +75131,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: - - *472 - - *473 + - *474 + - *475 - *75 requestBody: required: true @@ -75112,8 +75182,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: - - *472 - - *473 + - *474 + - *475 - *75 responses: '200': *287 @@ -75143,8 +75213,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: - - *472 - - *473 + - *474 + - *475 - *75 - *288 responses: @@ -75174,9 +75244,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: - - *472 - - *473 - - &508 + - *474 + - *475 + - &510 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. @@ -75184,7 +75254,7 @@ paths: required: false schema: type: string - - &509 + - &511 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -75192,7 +75262,7 @@ paths: required: false schema: type: string - - &510 + - &512 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -75201,7 +75271,7 @@ paths: required: false schema: type: string - - &511 + - &513 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 @@ -75228,7 +75298,7 @@ paths: - pending - *17 - *19 - - &512 + - &514 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)." @@ -75237,7 +75307,7 @@ paths: schema: type: string format: date-time - - &493 + - &495 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -75246,13 +75316,13 @@ paths: schema: type: boolean default: false - - &513 + - &515 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &514 + - &516 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -75275,7 +75345,7 @@ paths: type: integer workflow_runs: type: array - items: &494 + items: &496 title: Workflow Run description: An invocation of a workflow type: object @@ -75453,7 +75523,7 @@ paths: head_commit: anyOf: - type: 'null' - - &538 + - &540 title: Simple Commit description: A commit. type: object @@ -75568,7 +75638,7 @@ paths: - workflow_url - pull_requests examples: - default: &515 + default: &517 value: total_count: 1 workflow_runs: @@ -75804,24 +75874,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *472 - - *473 - - &495 + - *474 + - *475 + - &497 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *493 + - *495 responses: '200': description: Response content: application/json: - schema: *494 + schema: *496 examples: - default: &498 + default: &500 value: id: 30433642 name: Build @@ -76062,9 +76132,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 responses: '204': description: Response @@ -76087,9 +76157,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: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 responses: '200': description: Response @@ -76217,9 +76287,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: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 responses: '201': description: Response @@ -76252,12 +76322,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 - *17 - *19 - - *496 + - *498 - *110 responses: '200': @@ -76274,9 +76344,9 @@ paths: type: integer artifacts: type: array - items: *481 + items: *483 examples: - default: *497 + default: *499 headers: Link: *45 x-github: @@ -76300,25 +76370,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *472 - - *473 - - *495 - - &499 + - *474 + - *475 + - *497 + - &501 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *493 + - *495 responses: '200': description: Response content: application/json: - schema: *494 + schema: *496 examples: - default: *498 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76341,10 +76411,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: - - *472 - - *473 - - *495 - - *499 + - *474 + - *475 + - *497 + - *501 - *17 - *19 responses: @@ -76362,9 +76432,9 @@ paths: type: integer jobs: type: array - items: *500 + items: *502 examples: - default: &501 + default: &503 value: total_count: 1 jobs: @@ -76477,10 +76547,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *472 - - *473 - - *495 - - *499 + - *474 + - *475 + - *497 + - *501 responses: '302': description: Response @@ -76508,9 +76578,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 responses: '202': description: Response @@ -76556,9 +76626,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run parameters: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 - *17 - *108 - *109 @@ -76735,9 +76805,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: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 requestBody: required: true content: @@ -76804,9 +76874,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 responses: '202': description: Response @@ -76839,9 +76909,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: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 - 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 @@ -76871,9 +76941,9 @@ paths: type: integer jobs: type: array - items: *500 + items: *502 examples: - default: *501 + default: *503 headers: Link: *45 x-github: @@ -76898,9 +76968,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 responses: '302': description: Response @@ -76927,9 +76997,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 responses: '204': description: Response @@ -76956,9 +77026,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: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 responses: '200': description: Response @@ -77027,7 +77097,7 @@ paths: items: type: object properties: - type: &626 + type: &628 type: string description: The type of reviewer. enum: @@ -77113,9 +77183,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: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 requestBody: required: true content: @@ -77165,7 +77235,7 @@ paths: application/json: schema: type: array - items: &613 + items: &615 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -77277,7 +77347,7 @@ paths: - created_at - updated_at examples: - default: &614 + default: &616 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -77333,9 +77403,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 requestBody: required: false content: @@ -77380,9 +77450,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: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 requestBody: required: false content: @@ -77437,9 +77507,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *472 - - *473 - - *495 + - *474 + - *475 + - *497 responses: '200': description: Response @@ -77576,8 +77646,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-secrets parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -77595,9 +77665,9 @@ paths: type: integer secrets: type: array - items: *502 + items: *504 examples: - default: *503 + default: *505 headers: Link: *45 x-github: @@ -77622,8 +77692,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -77653,17 +77723,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-secret parameters: - - *472 - - *473 + - *474 + - *475 - *290 responses: '200': description: Response content: application/json: - schema: *502 + schema: *504 examples: - default: &516 + default: &518 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -77689,8 +77759,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *472 - - *473 + - *474 + - *475 - *290 requestBody: required: true @@ -77748,8 +77818,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-a-repository-secret parameters: - - *472 - - *473 + - *474 + - *475 - *290 responses: '204': @@ -77775,8 +77845,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-variables parameters: - - *472 - - *473 + - *474 + - *475 - *299 - *19 responses: @@ -77794,9 +77864,9 @@ paths: type: integer variables: type: array - items: *504 + items: *506 examples: - default: *505 + default: *507 headers: Link: *45 x-github: @@ -77819,8 +77889,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-a-repository-variable parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -77872,17 +77942,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-a-repository-variable parameters: - - *472 - - *473 + - *474 + - *475 - *293 responses: '200': description: Response content: application/json: - schema: *504 + schema: *506 examples: - default: &517 + default: &519 value: name: USERNAME value: octocat @@ -77908,8 +77978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-a-repository-variable parameters: - - *472 - - *473 + - *474 + - *475 - *293 requestBody: required: true @@ -77952,8 +78022,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-a-repository-variable parameters: - - *472 - - *473 + - *474 + - *475 - *293 responses: '204': @@ -77979,8 +78049,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#list-repository-workflows parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -77998,7 +78068,7 @@ paths: type: integer workflows: type: array - items: &506 + items: &508 title: Workflow description: A GitHub Actions workflow type: object @@ -78116,9 +78186,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-a-workflow parameters: - - *472 - - *473 - - &507 + - *474 + - *475 + - &509 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -78133,7 +78203,7 @@ paths: description: Response content: application/json: - schema: *506 + schema: *508 examples: default: value: @@ -78166,9 +78236,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#disable-a-workflow parameters: - - *472 - - *473 - - *507 + - *474 + - *475 + - *509 responses: '204': description: Response @@ -78193,9 +78263,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *472 - - *473 - - *507 + - *474 + - *475 + - *509 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -78282,9 +78352,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#enable-a-workflow parameters: - - *472 - - *473 - - *507 + - *474 + - *475 + - *509 responses: '204': description: Response @@ -78311,19 +78381,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: - - *472 - - *473 - - *507 - - *508 + - *474 + - *475 - *509 - *510 - *511 - - *17 - - *19 - *512 - - *493 - *513 + - *17 + - *19 - *514 + - *495 + - *515 + - *516 responses: '200': description: Response @@ -78339,9 +78409,9 @@ paths: type: integer workflow_runs: type: array - items: *494 + items: *496 examples: - default: *515 + default: *517 headers: Link: *45 x-github: @@ -78374,9 +78444,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-workflow-usage parameters: - - *472 - - *473 - - *507 + - *474 + - *475 + - *509 responses: '200': description: Response @@ -78437,8 +78507,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-activities parameters: - - *472 - - *473 + - *474 + - *475 - *110 - *17 - *108 @@ -78611,8 +78681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/secrets#list-repository-organization-secrets parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -78630,9 +78700,9 @@ paths: type: integer secrets: type: array - items: *502 + items: *504 examples: - default: *503 + default: *505 headers: Link: *45 x-github: @@ -78656,8 +78726,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/variables#list-repository-organization-variables parameters: - - *472 - - *473 + - *474 + - *475 - *299 - *19 responses: @@ -78675,9 +78745,9 @@ paths: type: integer variables: type: array - items: *504 + items: *506 examples: - default: *505 + default: *507 headers: Link: *45 x-github: @@ -78702,8 +78772,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/secrets#list-repository-secrets parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -78721,9 +78791,9 @@ paths: type: integer secrets: type: array - items: *502 + items: *504 examples: - default: *503 + default: *505 headers: Link: *45 x-github: @@ -78748,8 +78818,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/secrets#get-a-repository-public-key parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -78779,17 +78849,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/secrets#get-a-repository-secret parameters: - - *472 - - *473 + - *474 + - *475 - *290 responses: '200': description: Response content: application/json: - schema: *502 + schema: *504 examples: - default: *516 + default: *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78811,8 +78881,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/secrets#create-or-update-a-repository-secret parameters: - - *472 - - *473 + - *474 + - *475 - *290 requestBody: required: true @@ -78870,8 +78940,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/secrets#delete-a-repository-secret parameters: - - *472 - - *473 + - *474 + - *475 - *290 responses: '204': @@ -78897,8 +78967,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/variables#list-repository-variables parameters: - - *472 - - *473 + - *474 + - *475 - *299 - *19 responses: @@ -78916,9 +78986,9 @@ paths: type: integer variables: type: array - items: *504 + items: *506 examples: - default: *505 + default: *507 headers: Link: *45 x-github: @@ -78941,8 +79011,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/variables#create-a-repository-variable parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -78994,17 +79064,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/variables#get-a-repository-variable parameters: - - *472 - - *473 + - *474 + - *475 - *293 responses: '200': description: Response content: application/json: - schema: *504 + schema: *506 examples: - default: *517 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79025,8 +79095,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/variables#update-a-repository-variable parameters: - - *472 - - *473 + - *474 + - *475 - *293 requestBody: required: true @@ -79069,8 +79139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/agents/variables#delete-a-repository-variable parameters: - - *472 - - *473 + - *474 + - *475 - *293 responses: '204': @@ -79092,8 +79162,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#list-assignees parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -79130,8 +79200,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: - - *472 - - *473 + - *474 + - *475 - name: assignee in: path required: true @@ -79167,8 +79237,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#create-an-attestation parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -79278,8 +79348,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#list-attestations parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *108 - *109 @@ -79336,7 +79406,7 @@ paths: initiator: type: string examples: - default: *518 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79356,8 +79426,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -79365,7 +79435,7 @@ paths: application/json: schema: type: array - items: &519 + items: &521 title: Autolink reference description: An autolink reference. type: object @@ -79424,8 +79494,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -79464,9 +79534,9 @@ paths: description: response content: application/json: - schema: *519 + schema: *521 examples: - default: &520 + default: &522 value: id: 1 key_prefix: TICKET- @@ -79497,9 +79567,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: - - *472 - - *473 - - &521 + - *474 + - *475 + - &523 name: autolink_id description: The unique identifier of the autolink. in: path @@ -79511,9 +79581,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *521 examples: - default: *520 + default: *522 '404': *6 x-github: githubCloudOnly: false @@ -79533,9 +79603,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: - - *472 - - *473 - - *521 + - *474 + - *475 + - *523 responses: '204': description: Response @@ -79559,8 +79629,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response if Dependabot is enabled @@ -79610,8 +79680,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-dependabot-security-updates parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -79632,8 +79702,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-dependabot-security-updates parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -79653,8 +79723,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#list-branches parameters: - - *472 - - *473 + - *474 + - *475 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -79692,7 +79762,7 @@ paths: - url protected: type: boolean - protection: &523 + protection: &525 title: Branch Protection description: Branch Protection type: object @@ -79735,7 +79805,7 @@ paths: required: - contexts - checks - enforce_admins: &526 + enforce_admins: &528 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -79752,7 +79822,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &528 + required_pull_request_reviews: &530 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -79836,7 +79906,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &525 + restrictions: &527 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -80129,9 +80199,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#get-a-branch parameters: - - *472 - - *473 - - &524 + - *474 + - *475 + - &526 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). @@ -80145,14 +80215,14 @@ paths: description: Response content: application/json: - schema: &534 + schema: &536 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &585 + commit: &587 title: Commit description: Commit type: object @@ -80191,7 +80261,7 @@ paths: author: anyOf: - type: 'null' - - &522 + - &524 title: Git User description: Metaproperties for Git author/committer information. @@ -80213,7 +80283,7 @@ paths: committer: anyOf: - type: 'null' - - *522 + - *524 message: type: string examples: @@ -80237,7 +80307,7 @@ paths: required: - sha - url - verification: &644 + verification: &646 title: Verification type: object properties: @@ -80317,7 +80387,7 @@ paths: type: integer files: type: array - items: &596 + items: &598 title: Diff Entry description: Diff Entry type: object @@ -80413,7 +80483,7 @@ paths: - self protected: type: boolean - protection: *523 + protection: *525 protection_url: type: string format: uri @@ -80522,7 +80592,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *478 + '301': *480 '404': *6 x-github: githubCloudOnly: false @@ -80544,15 +80614,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-branch-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response content: application/json: - schema: *523 + schema: *525 examples: default: value: @@ -80746,9 +80816,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-branch-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: true content: @@ -81008,7 +81078,7 @@ paths: url: type: string format: uri - required_status_checks: &531 + required_status_checks: &533 title: Status Check Policy description: Status Check Policy type: object @@ -81167,7 +81237,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *525 + restrictions: *527 required_conversation_resolution: type: object properties: @@ -81279,9 +81349,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-branch-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '204': description: Response @@ -81306,17 +81376,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response content: application/json: - schema: *526 + schema: *528 examples: - default: &527 + default: &529 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -81338,17 +81408,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response content: application/json: - schema: *526 + schema: *528 examples: - default: *527 + default: *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81367,9 +81437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '204': description: Response @@ -81394,17 +81464,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response content: application/json: - schema: *528 + schema: *530 examples: - default: &529 + default: &531 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -81500,9 +81570,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: false content: @@ -81600,9 +81670,9 @@ paths: description: Response content: application/json: - schema: *528 + schema: *530 examples: - default: *529 + default: *531 '422': *15 x-github: githubCloudOnly: false @@ -81623,9 +81693,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '204': description: Response @@ -81652,17 +81722,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response content: application/json: - schema: *526 + schema: *528 examples: - default: &530 + default: &532 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -81685,17 +81755,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response content: application/json: - schema: *526 + schema: *528 examples: - default: *530 + default: *532 '404': *6 x-github: githubCloudOnly: false @@ -81715,9 +81785,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '204': description: Response @@ -81742,17 +81812,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-status-checks-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response content: application/json: - schema: *531 + schema: *533 examples: - default: &532 + default: &534 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -81778,9 +81848,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-status-check-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: false content: @@ -81832,9 +81902,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *533 examples: - default: *532 + default: *534 '404': *6 '422': *15 x-github: @@ -81856,9 +81926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-protection parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '204': description: Response @@ -81882,9 +81952,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response @@ -81918,9 +81988,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-status-check-contexts parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: false content: @@ -81987,9 +82057,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-status-check-contexts parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: false content: @@ -82053,9 +82123,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: content: application/json: @@ -82121,15 +82191,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-access-restrictions parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response content: application/json: - schema: *525 + schema: *527 examples: default: value: @@ -82220,9 +82290,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-access-restrictions parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '204': description: Response @@ -82245,9 +82315,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: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response @@ -82257,7 +82327,7 @@ paths: type: array items: *5 examples: - default: &533 + default: &535 value: - id: 1 slug: octoapp @@ -82314,9 +82384,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: true content: @@ -82350,7 +82420,7 @@ paths: type: array items: *5 examples: - default: *533 + default: *535 '422': *15 x-github: githubCloudOnly: false @@ -82371,9 +82441,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: true content: @@ -82407,7 +82477,7 @@ paths: type: array items: *5 examples: - default: *533 + default: *535 '422': *15 x-github: githubCloudOnly: false @@ -82428,9 +82498,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: true content: @@ -82464,7 +82534,7 @@ paths: type: array items: *5 examples: - default: *533 + default: *535 '422': *15 x-github: githubCloudOnly: false @@ -82486,9 +82556,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: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response @@ -82518,9 +82588,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: false content: @@ -82579,9 +82649,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: false content: @@ -82640,9 +82710,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: content: application/json: @@ -82701,9 +82771,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: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 responses: '200': description: Response @@ -82737,9 +82807,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: true content: @@ -82797,9 +82867,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: true content: @@ -82857,9 +82927,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: true content: @@ -82919,9 +82989,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#rename-a-branch parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 requestBody: required: true content: @@ -82943,7 +83013,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *536 examples: default: value: @@ -83057,8 +83127,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *472 - - *473 + - *474 + - *475 - *103 - *104 - *105 @@ -83094,8 +83164,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *472 - - *473 + - *474 + - *475 - name: bypass_request_number in: path required: true @@ -83168,8 +83238,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *472 - - *473 + - *474 + - *475 - *103 - *104 - *105 @@ -83209,8 +83279,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *472 - - *473 + - *474 + - *475 - name: bypass_request_number in: path required: true @@ -83280,8 +83350,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *472 - - *473 + - *474 + - *475 - name: bypass_request_number in: path required: true @@ -83352,8 +83422,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *472 - - *473 + - *474 + - *475 - name: bypass_response_id in: path required: true @@ -83386,8 +83456,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -83666,7 +83736,7 @@ paths: description: Response content: application/json: - schema: &535 + schema: &537 title: CheckRun description: A check performed on the code of a given code change type: object @@ -83802,7 +83872,7 @@ paths: check. type: array items: *224 - deployment: &884 + deployment: &886 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -84089,9 +84159,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#get-a-check-run parameters: - - *472 - - *473 - - &536 + - *474 + - *475 + - &538 name: check_run_id description: The unique identifier of the check run. in: path @@ -84103,9 +84173,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *537 examples: - default: &537 + default: &539 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -84205,9 +84275,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run parameters: - - *472 - - *473 - - *536 + - *474 + - *475 + - *538 requestBody: required: true content: @@ -84447,9 +84517,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *537 examples: - default: *537 + default: *539 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84469,9 +84539,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-run-annotations parameters: - - *472 - - *473 - - *536 + - *474 + - *475 + - *538 - *17 - *19 responses: @@ -84581,9 +84651,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#rerequest-a-check-run parameters: - - *472 - - *473 - - *536 + - *474 + - *475 + - *538 responses: '201': description: Response @@ -84627,8 +84697,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -84650,7 +84720,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &539 + schema: &541 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -84748,7 +84818,7 @@ paths: - string - 'null' format: date-time - head_commit: *538 + head_commit: *540 latest_check_runs_count: type: integer check_runs_url: @@ -84776,7 +84846,7 @@ paths: - check_runs_url - pull_requests examples: - default: &540 + default: &542 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -85067,9 +85137,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *539 + schema: *541 examples: - default: *540 + default: *542 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85088,8 +85158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -85398,9 +85468,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite parameters: - - *472 - - *473 - - &541 + - *474 + - *475 + - &543 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -85412,9 +85482,9 @@ paths: description: Response content: application/json: - schema: *539 + schema: *541 examples: - default: *540 + default: *542 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85437,17 +85507,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: - - *472 - - *473 - - *541 - - &591 + - *474 + - *475 + - *543 + - &593 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &592 + - &594 name: status description: Returns check runs with the specified `status`. in: query @@ -85486,9 +85556,9 @@ paths: type: integer check_runs: type: array - items: *535 + items: *537 examples: - default: &593 + default: &595 value: total_count: 1 check_runs: @@ -85590,9 +85660,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#rerequest-a-check-suite parameters: - - *472 - - *473 - - *541 + - *474 + - *475 + - *543 responses: '201': description: Response @@ -85625,21 +85695,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: - - *472 - - *473 + - *474 + - *475 - *317 - *318 - *19 - *17 - - &557 + - &559 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: *542 - - &558 + schema: *544 + - &560 name: pr description: The number of the pull request for the results you want to list. in: query @@ -85670,7 +85740,7 @@ paths: be returned. in: query required: false - schema: *543 + schema: *545 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -85694,7 +85764,7 @@ paths: updated_at: *138 url: *135 html_url: *136 - instances_url: *544 + instances_url: *546 state: *113 fixed_at: *140 dismissed_by: @@ -85702,11 +85772,11 @@ paths: - type: 'null' - *4 dismissed_at: *139 - dismissed_reason: *545 - dismissed_comment: *546 - rule: *547 - tool: *548 - most_recent_instance: *549 + dismissed_reason: *547 + dismissed_comment: *548 + rule: *549 + tool: *550 + most_recent_instance: *551 dismissal_approved_by: anyOf: - type: 'null' @@ -85829,7 +85899,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &550 + '403': &552 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -85856,9 +85926,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: - - *472 - - *473 - - &551 + - *474 + - *475 + - &553 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -85872,7 +85942,7 @@ paths: description: Response content: application/json: - schema: &552 + schema: &554 type: object properties: number: *130 @@ -85880,7 +85950,7 @@ paths: updated_at: *138 url: *135 html_url: *136 - instances_url: *544 + instances_url: *546 state: *113 fixed_at: *140 dismissed_by: @@ -85888,8 +85958,8 @@ paths: - type: 'null' - *4 dismissed_at: *139 - dismissed_reason: *545 - dismissed_comment: *546 + dismissed_reason: *547 + dismissed_comment: *548 rule: type: object properties: @@ -85951,8 +86021,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *548 - most_recent_instance: *549 + tool: *550 + most_recent_instance: *551 dismissal_approved_by: anyOf: - type: 'null' @@ -86048,7 +86118,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *550 + '403': *552 '404': *6 '503': *195 x-github: @@ -86068,9 +86138,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: - - *472 - - *473 - - *551 + - *474 + - *475 + - *553 requestBody: required: true content: @@ -86085,8 +86155,8 @@ paths: enum: - open - dismissed - dismissed_reason: *545 - dismissed_comment: *546 + dismissed_reason: *547 + dismissed_comment: *548 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -86114,7 +86184,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *554 examples: default: value: @@ -86190,7 +86260,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &556 + '403': &558 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -86217,15 +86287,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: - - *472 - - *473 - - *551 + - *474 + - *475 + - *553 responses: '200': description: Response content: application/json: - schema: &553 + schema: &555 type: object properties: status: @@ -86252,13 +86322,13 @@ paths: - description - started_at examples: - default: &554 + default: &556 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &555 + '400': &557 description: Bad Request content: application/json: @@ -86269,7 +86339,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': *550 + '403': *552 '404': *6 '500': *38 x-github: @@ -86294,29 +86364,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: - - *472 - - *473 - - *551 + - *474 + - *475 + - *553 responses: '200': description: OK content: application/json: - schema: *553 + schema: *555 examples: - default: *554 + default: *556 '202': description: Accepted content: application/json: - schema: *553 + schema: *555 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *555 + '400': *557 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -86348,9 +86418,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: - - *472 - - *473 - - *551 + - *474 + - *475 + - *553 requestBody: required: false content: @@ -86396,8 +86466,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *555 - '403': *556 + '400': *557 + '403': *558 '404': *6 '422': description: Unprocessable Entity @@ -86421,13 +86491,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: - - *472 - - *473 - - *551 + - *474 + - *475 + - *553 - *19 - *17 - - *557 - - *558 + - *559 + - *560 responses: '200': description: Response @@ -86438,10 +86508,10 @@ paths: items: type: object properties: - ref: *542 - analysis_key: *559 - environment: *560 - category: *561 + ref: *544 + analysis_key: *561 + environment: *562 + category: *563 state: type: - string @@ -86458,7 +86528,7 @@ paths: properties: text: type: string - location: *562 + location: *564 html_url: type: string classifications: @@ -86466,7 +86536,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: *563 + items: *565 examples: default: value: @@ -86503,7 +86573,7 @@ paths: end_column: 50 classifications: - source - '403': *550 + '403': *552 '404': *6 '503': *195 x-github: @@ -86537,25 +86607,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: - - *472 - - *473 + - *474 + - *475 - *317 - *318 - *19 - *17 - - *558 + - *560 - 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: *542 + schema: *544 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &564 + schema: &566 type: string description: An identifier for the upload. examples: @@ -86577,23 +86647,23 @@ paths: application/json: schema: type: array - items: &565 + items: &567 type: object properties: - ref: *542 - commit_sha: &573 + ref: *544 + commit_sha: &575 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 64 pattern: "^([0-9a-fA-F]{40}(?:[0-9a-fA-F]{24})?)$" - analysis_key: *559 + analysis_key: *561 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *561 + category: *563 error: type: string examples: @@ -86618,8 +86688,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *564 - tool: *548 + sarif_id: *566 + tool: *550 deletable: type: boolean warning: @@ -86681,7 +86751,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *550 + '403': *552 '404': *6 '503': *195 x-github: @@ -86717,8 +86787,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: - - *472 - - *473 + - *474 + - *475 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -86731,7 +86801,7 @@ paths: description: Response content: application/json: - schema: *565 + schema: *567 examples: response: summary: application/json response @@ -86785,7 +86855,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *550 + '403': *552 '404': *6 '422': description: Response if analysis could not be processed @@ -86872,8 +86942,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: - - *472 - - *473 + - *474 + - *475 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -86929,7 +86999,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': *556 + '403': *558 '404': *6 '503': *195 x-github: @@ -86951,8 +87021,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -86960,7 +87030,7 @@ paths: application/json: schema: type: array - items: &566 + items: &568 title: CodeQL Database description: A CodeQL database. type: object @@ -87072,7 +87142,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': *550 + '403': *552 '404': *6 '503': *195 x-github: @@ -87101,8 +87171,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: - - *472 - - *473 + - *474 + - *475 - name: language in: path description: The language of the CodeQL database. @@ -87114,7 +87184,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *568 examples: default: value: @@ -87146,9 +87216,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': &600 + '302': &602 description: Found - '403': *550 + '403': *552 '404': *6 '503': *195 x-github: @@ -87170,8 +87240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *472 - - *473 + - *474 + - *475 - name: language in: path description: The language of the CodeQL database. @@ -87181,7 +87251,7 @@ paths: responses: '204': description: Response - '403': *556 + '403': *558 '404': *6 '503': *195 x-github: @@ -87209,8 +87279,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -87219,7 +87289,7 @@ paths: type: object additionalProperties: false properties: - language: &567 + language: &569 type: string description: The language targeted by the CodeQL query enum: @@ -87299,7 +87369,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &571 + schema: &573 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -87309,7 +87379,7 @@ paths: description: The ID of the variant analysis. controller_repo: *120 actor: *4 - query_language: *567 + query_language: *569 query_pack_url: type: string description: The download url for the query pack. @@ -87357,7 +87427,7 @@ paths: items: type: object properties: - repository: &568 + repository: &570 title: Repository Identifier description: Repository Identifier type: object @@ -87399,7 +87469,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &572 + analysis_status: &574 type: string description: The new status of the CodeQL variant analysis repository task. @@ -87431,7 +87501,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &569 + access_mismatch_repos: &571 type: object properties: repository_count: @@ -87446,7 +87516,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: *568 + items: *570 required: - repository_count - repositories @@ -87469,8 +87539,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *569 - over_limit_repos: *569 + no_codeql_db_repos: *571 + over_limit_repos: *571 required: - access_mismatch_repos - not_found_repos @@ -87486,7 +87556,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &570 + value: &572 summary: Default response value: id: 1 @@ -87632,10 +87702,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *570 + value: *572 repository_lists: summary: Response for a successful variant analysis submission - value: *570 + value: *572 '404': *6 '422': description: Unable to process variant analysis submission @@ -87663,8 +87733,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: - - *472 - - *473 + - *474 + - *475 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -87676,9 +87746,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *573 examples: - default: *570 + default: *572 '404': *6 '503': *195 x-github: @@ -87701,7 +87771,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: - - *472 + - *474 - name: repo in: path description: The name of the controller repository. @@ -87736,7 +87806,7 @@ paths: type: object properties: repository: *120 - analysis_status: *572 + analysis_status: *574 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -87861,8 +87931,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -87955,7 +88025,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *550 + '403': *552 '404': *6 '503': *195 x-github: @@ -87976,8 +88046,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -88071,7 +88141,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *556 + '403': *558 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -88142,8 +88212,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -88151,7 +88221,7 @@ paths: schema: type: object properties: - commit_sha: *573 + commit_sha: *575 ref: type: string description: |- @@ -88211,7 +88281,7 @@ paths: schema: type: object properties: - id: *564 + id: *566 url: type: string description: The REST API URL for checking the status of the upload. @@ -88225,7 +88295,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': *556 + '403': *558 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -88248,8 +88318,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: - - *472 - - *473 + - *474 + - *475 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -88297,7 +88367,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': *550 + '403': *552 '404': description: Not Found if the sarif id does not match any upload '503': *195 @@ -88322,8 +88392,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -88404,8 +88474,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-codeowners-errors parameters: - - *472 - - *473 + - *474 + - *475 - 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 @@ -88533,8 +88603,8 @@ paths: parameters: - *17 - *19 - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -88848,8 +88918,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -88915,7 +88985,7 @@ paths: application/json: schema: *391 examples: - default: *574 + default: *576 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -88923,7 +88993,7 @@ paths: application/json: schema: *391 examples: - default: *574 + default: *576 '400': *14 '401': *23 '403': *27 @@ -88952,8 +89022,8 @@ paths: parameters: - *17 - *19 - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -89017,8 +89087,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: - - *472 - - *473 + - *474 + - *475 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -89055,9 +89125,9 @@ paths: type: integer machines: type: array - items: *575 + items: *577 examples: - default: &828 + default: &830 value: total_count: 2 machines: @@ -89097,8 +89167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *472 - - *473 + - *474 + - *475 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -89185,8 +89255,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: - - *472 - - *473 + - *474 + - *475 - 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 @@ -89255,8 +89325,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -89274,7 +89344,7 @@ paths: type: integer secrets: type: array - items: &579 + items: &581 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -89295,7 +89365,7 @@ paths: - created_at - updated_at examples: - default: *576 + default: *578 headers: Link: *45 x-github: @@ -89318,16 +89388,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response content: application/json: - schema: *577 + schema: *579 examples: - default: *578 + default: *580 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -89347,17 +89417,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *472 - - *473 + - *474 + - *475 - *290 responses: '200': description: Response content: application/json: - schema: *579 + schema: *581 examples: - default: *580 + default: *582 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89377,8 +89447,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: - - *472 - - *473 + - *474 + - *475 - *290 requestBody: required: true @@ -89431,8 +89501,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *472 - - *473 + - *474 + - *475 - *290 responses: '204': @@ -89461,8 +89531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *472 - - *473 + - *474 + - *475 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -89500,7 +89570,7 @@ paths: application/json: schema: type: array - items: &581 + items: &583 title: Collaborator description: Collaborator type: object @@ -89693,8 +89763,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: - - *472 - - *473 + - *474 + - *475 - *143 responses: '204': @@ -89741,8 +89811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *472 - - *473 + - *474 + - *475 - *143 requestBody: required: false @@ -89769,7 +89839,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &657 + schema: &659 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -89997,8 +90067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *472 - - *473 + - *474 + - *475 - *143 responses: '204': @@ -90030,8 +90100,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *472 - - *473 + - *474 + - *475 - *143 responses: '200': @@ -90052,7 +90122,7 @@ paths: user: anyOf: - type: 'null' - - *581 + - *583 required: - permission - role_name @@ -90106,8 +90176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -90117,7 +90187,7 @@ paths: application/json: schema: type: array - items: &582 + items: &584 title: Commit Comment description: Commit Comment type: object @@ -90175,7 +90245,7 @@ paths: - created_at - updated_at examples: - default: &587 + default: &589 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -90234,17 +90304,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 responses: '200': description: Response content: application/json: - schema: *582 + schema: *584 examples: - default: &588 + default: &590 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -90301,8 +90371,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#update-a-commit-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 requestBody: required: true @@ -90325,7 +90395,7 @@ paths: description: Response content: application/json: - schema: *582 + schema: *584 examples: default: value: @@ -90376,8 +90446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#delete-a-commit-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 responses: '204': @@ -90399,8 +90469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -90427,7 +90497,7 @@ paths: application/json: schema: type: array - items: &583 + items: &585 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -90471,7 +90541,7 @@ paths: - content - created_at examples: - default: &661 + default: &663 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -90516,8 +90586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 requestBody: required: true @@ -90550,9 +90620,9 @@ paths: description: Reaction exists content: application/json: - schema: *583 + schema: *585 examples: - default: &584 + default: &586 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -90581,9 +90651,9 @@ paths: description: Reaction created content: application/json: - schema: *583 + schema: *585 examples: - default: *584 + default: *586 '422': *15 x-github: githubCloudOnly: false @@ -90605,10 +90675,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *472 - - *473 + - *474 + - *475 - *235 - - &662 + - &664 name: reaction_id description: The unique identifier of the reaction. in: path @@ -90663,8 +90733,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits parameters: - - *472 - - *473 + - *474 + - *475 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -90720,9 +90790,9 @@ paths: application/json: schema: type: array - items: *585 + items: *587 examples: - default: &725 + default: &727 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -90816,9 +90886,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-branches-for-head-commit parameters: - - *472 - - *473 - - &586 + - *474 + - *475 + - &588 name: commit_sha description: The SHA of the commit. in: path @@ -90890,9 +90960,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments parameters: - - *472 - - *473 - - *586 + - *474 + - *475 + - *588 - *17 - *19 responses: @@ -90902,9 +90972,9 @@ paths: application/json: schema: type: array - items: *582 + items: *584 examples: - default: *587 + default: *589 headers: Link: *45 x-github: @@ -90932,9 +91002,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#create-a-commit-comment parameters: - - *472 - - *473 - - *586 + - *474 + - *475 + - *588 requestBody: required: true content: @@ -90969,9 +91039,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *584 examples: - default: *588 + default: *590 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -90999,9 +91069,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: - - *472 - - *473 - - *586 + - *474 + - *475 + - *588 - *17 - *19 responses: @@ -91011,9 +91081,9 @@ paths: application/json: schema: type: array - items: *589 + items: *591 examples: - default: &717 + default: &719 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -91550,11 +91620,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#get-a-commit parameters: - - *472 - - *473 + - *474 + - *475 - *19 - *17 - - &590 + - &592 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)" @@ -91569,9 +91639,9 @@ paths: description: Response content: application/json: - schema: *585 + schema: *587 examples: - default: &703 + default: &705 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -91659,7 +91729,7 @@ paths: schema: type: string examples: - default: &597 + default: &599 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -91672,7 +91742,7 @@ paths: schema: type: string examples: - default: &598 + default: &600 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -91725,11 +91795,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: - - *472 - - *473 - - *590 - - *591 + - *474 + - *475 - *592 + - *593 + - *594 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -91763,9 +91833,9 @@ paths: type: integer check_runs: type: array - items: *535 + items: *537 examples: - default: *593 + default: *595 headers: Link: *45 x-github: @@ -91790,9 +91860,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: - - *472 - - *473 - - *590 + - *474 + - *475 + - *592 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -91800,7 +91870,7 @@ paths: schema: type: integer example: 1 - - *591 + - *593 - *17 - *19 responses: @@ -91818,7 +91888,7 @@ paths: type: integer check_suites: type: array - items: *539 + items: *541 examples: default: value: @@ -92018,9 +92088,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: - - *472 - - *473 - - *590 + - *474 + - *475 + - *592 - *17 - *19 responses: @@ -92222,9 +92292,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *472 - - *473 - - *590 + - *474 + - *475 + - *592 - *17 - *19 responses: @@ -92234,7 +92304,7 @@ paths: application/json: schema: type: array - items: &780 + items: &782 title: Status description: The status of a commit. type: object @@ -92315,7 +92385,7 @@ paths: site_admin: false headers: Link: *45 - '301': *478 + '301': *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92343,8 +92413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/community#get-community-profile-metrics parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -92377,11 +92447,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *594 + - *596 code_of_conduct_file: anyOf: - type: 'null' - - &595 + - &597 title: Community Health File type: object properties: @@ -92401,19 +92471,19 @@ paths: contributing: anyOf: - type: 'null' - - *595 + - *597 readme: anyOf: - type: 'null' - - *595 + - *597 issue_template: anyOf: - type: 'null' - - *595 + - *597 pull_request_template: anyOf: - type: 'null' - - *595 + - *597 required: - code_of_conduct - code_of_conduct_file @@ -92542,8 +92612,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#compare-two-commits parameters: - - *472 - - *473 + - *474 + - *475 - *19 - *17 - name: basehead @@ -92591,8 +92661,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *585 - merge_base_commit: *585 + base_commit: *587 + merge_base_commit: *587 status: type: string enum: @@ -92616,10 +92686,10 @@ paths: - 6 commits: type: array - items: *585 + items: *587 files: type: array - items: *596 + items: *598 required: - url - html_url @@ -92865,12 +92935,12 @@ paths: schema: type: string examples: - default: *597 + default: *599 application/vnd.github.patch: schema: type: string examples: - default: *598 + default: *600 '404': *6 '500': *38 '503': *195 @@ -92915,8 +92985,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-repository-content parameters: - - *472 - - *473 + - *474 + - *475 - name: path description: path parameter in: path @@ -93086,7 +93156,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &599 + response-if-content-is-a-file-github-object: &601 summary: Response if content is a file value: type: file @@ -93223,7 +93293,7 @@ paths: - size - type - url - - &730 + - &732 title: Content File description: Content File type: object @@ -93441,7 +93511,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *599 + response-if-content-is-a-file: *601 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -93510,7 +93580,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *600 + '302': *602 '304': *35 x-github: githubCloudOnly: false @@ -93533,8 +93603,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#create-or-update-file-contents parameters: - - *472 - - *473 + - *474 + - *475 - name: path description: path parameter in: path @@ -93629,7 +93699,7 @@ paths: description: Response content: application/json: - schema: &601 + schema: &603 title: File Commit description: File Commit type: object @@ -93785,7 +93855,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: example-for-creating-a-file: value: @@ -93839,7 +93909,7 @@ paths: schema: oneOf: - *3 - - &639 + - &641 description: Repository rule violation was detected type: object properties: @@ -93860,7 +93930,7 @@ paths: items: type: object properties: - placeholder_id: &772 + placeholder_id: &774 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -93892,8 +93962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#delete-a-file parameters: - - *472 - - *473 + - *474 + - *475 - name: path description: path parameter in: path @@ -93954,7 +94024,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: default: value: @@ -94009,8 +94079,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-contributors parameters: - - *472 - - *473 + - *474 + - *475 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -94140,8 +94210,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-cloud-agent-management#get-copilot-cloud-agent-configuration-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -94274,8 +94344,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 - *338 - *339 - *340 @@ -94288,7 +94358,7 @@ paths: schema: type: string - *343 - - *602 + - *604 - *344 - *345 - *346 @@ -94303,7 +94373,7 @@ paths: application/json: schema: type: array - items: &606 + items: &608 type: object description: A Dependabot alert. properties: @@ -94354,7 +94424,7 @@ paths: - transitive - inconclusive - - security_advisory: *603 + security_advisory: *605 security_vulnerability: *134 url: *135 html_url: *136 @@ -94385,8 +94455,8 @@ paths: dismissal. maxLength: 280 fixed_at: *140 - auto_dismissed_at: *604 - dismissal_request: *605 + auto_dismissed_at: *606 + dismissal_request: *607 assignees: type: array description: The users assigned to this alert. @@ -94641,9 +94711,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *472 - - *473 - - &607 + - *474 + - *475 + - &609 name: alert_number in: path description: |- @@ -94658,7 +94728,7 @@ paths: description: Response content: application/json: - schema: *606 + schema: *608 examples: default: value: @@ -94790,9 +94860,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *472 - - *473 - - *607 + - *474 + - *475 + - *609 requestBody: required: true content: @@ -94865,7 +94935,7 @@ paths: description: Response content: application/json: - schema: *606 + schema: *608 examples: default: value: @@ -94995,8 +95065,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-repository-secrets parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -95014,7 +95084,7 @@ paths: type: integer secrets: type: array - items: &610 + items: &612 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -95068,16 +95138,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response content: application/json: - schema: *608 + schema: *610 examples: - default: *609 + default: *611 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95097,15 +95167,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-secret parameters: - - *472 - - *473 + - *474 + - *475 - *290 responses: '200': description: Response content: application/json: - schema: *610 + schema: *612 examples: default: value: @@ -95131,8 +95201,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *472 - - *473 + - *474 + - *475 - *290 requestBody: required: true @@ -95185,8 +95255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *472 - - *473 + - *474 + - *475 - *290 responses: '204': @@ -95209,8 +95279,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: - - *472 - - *473 + - *474 + - *475 - 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 @@ -95387,8 +95457,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -95647,8 +95717,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 - name: sbom_uuid in: path required: true @@ -95659,7 +95729,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *611 + Location: *613 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -95680,8 +95750,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '201': description: Response @@ -95719,8 +95789,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -95803,7 +95873,7 @@ paths: - version - url additionalProperties: false - metadata: &612 + metadata: &614 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -95842,7 +95912,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *612 + metadata: *614 resolved: type: object description: A collection of resolved package dependencies. @@ -95856,7 +95926,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *612 + metadata: *614 relationship: type: string description: A notation of whether a dependency is requested @@ -95989,8 +96059,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments parameters: - - *472 - - *473 + - *474 + - *475 - name: sha description: The SHA recorded at creation time. in: query @@ -96031,9 +96101,9 @@ paths: application/json: schema: type: array - items: *613 + items: *615 examples: - default: *614 + default: *616 headers: Link: *45 x-github: @@ -96099,8 +96169,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#create-a-deployment parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -96182,7 +96252,7 @@ paths: description: Response content: application/json: - schema: *613 + schema: *615 examples: simple-example: summary: Simple example @@ -96255,9 +96325,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#get-a-deployment parameters: - - *472 - - *473 - - &615 + - *474 + - *475 + - &617 name: deployment_id description: deployment_id parameter in: path @@ -96269,7 +96339,7 @@ paths: description: Response content: application/json: - schema: *613 + schema: *615 examples: default: value: @@ -96334,9 +96404,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#delete-a-deployment parameters: - - *472 - - *473 - - *615 + - *474 + - *475 + - *617 responses: '204': description: Response @@ -96358,9 +96428,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses parameters: - - *472 - - *473 - - *615 + - *474 + - *475 + - *617 - *17 - *19 responses: @@ -96370,7 +96440,7 @@ paths: application/json: schema: type: array - items: &616 + items: &618 title: Deployment Status description: The status of a deployment. type: object @@ -96534,9 +96604,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status parameters: - - *472 - - *473 - - *615 + - *474 + - *475 + - *617 requestBody: required: true content: @@ -96611,9 +96681,9 @@ paths: description: Response content: application/json: - schema: *616 + schema: *618 examples: - default: &617 + default: &619 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -96669,9 +96739,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#get-a-deployment-status parameters: - - *472 - - *473 - - *615 + - *474 + - *475 + - *617 - name: status_id in: path required: true @@ -96682,9 +96752,9 @@ paths: description: Response content: application/json: - schema: *616 + schema: *618 examples: - default: *617 + default: *619 '404': *6 x-github: githubCloudOnly: false @@ -96711,12 +96781,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *472 - - *473 - - *618 - - *619 + - *474 + - *475 - *620 - *621 + - *622 + - *623 - *17 - *19 responses: @@ -96726,9 +96796,9 @@ paths: application/json: schema: type: array - items: *622 + items: *624 examples: - default: *623 + default: *625 '404': *6 '403': *27 '500': *38 @@ -96752,8 +96822,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *472 - - *473 + - *474 + - *475 - name: alert_number in: path required: true @@ -96765,7 +96835,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *622 + schema: *624 examples: default: value: @@ -96821,8 +96891,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *472 - - *473 + - *474 + - *475 - name: alert_number in: path required: true @@ -96881,12 +96951,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *472 - - *473 - - *618 - - *619 + - *474 + - *475 - *620 - *621 + - *622 + - *623 - *17 - *19 responses: @@ -96896,9 +96966,9 @@ paths: application/json: schema: type: array - items: *624 + items: *626 examples: - default: *625 + default: *627 '404': *6 '403': *27 '500': *38 @@ -96922,8 +96992,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *472 - - *473 + - *474 + - *475 - name: alert_number in: path required: true @@ -96935,7 +97005,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *624 + schema: *626 examples: default: value: @@ -96986,8 +97056,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *472 - - *473 + - *474 + - *475 - name: alert_number in: path required: true @@ -97025,7 +97095,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *624 + schema: *626 examples: default: value: @@ -97076,8 +97146,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *472 - - *473 + - *474 + - *475 - name: alert_number in: path required: true @@ -97148,8 +97218,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *472 - - *473 + - *474 + - *475 - name: alert_number in: path required: true @@ -97182,8 +97252,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *472 - - *473 + - *474 + - *475 - *103 - *104 - *105 @@ -97224,8 +97294,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *472 - - *473 + - *474 + - *475 - name: alert_number in: path required: true @@ -97295,8 +97365,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *472 - - *473 + - *474 + - *475 - name: alert_number in: path required: true @@ -97365,8 +97435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -97423,8 +97493,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#list-environments parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -97442,7 +97512,7 @@ paths: - 5 environments: type: array - items: &627 + items: &629 title: Environment description: Details of a deployment environment type: object @@ -97504,7 +97574,7 @@ paths: type: string examples: - wait_timer - wait_timer: &629 + wait_timer: &631 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -97546,7 +97616,7 @@ paths: items: type: object properties: - type: *626 + type: *628 reviewer: anyOf: - *4 @@ -97573,7 +97643,7 @@ paths: - id - node_id - type - deployment_branch_policy: &630 + deployment_branch_policy: &632 type: - object - 'null' @@ -97690,9 +97760,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#get-an-environment parameters: - - *472 - - *473 - - &628 + - *474 + - *475 + - &630 name: environment_name in: path required: true @@ -97705,9 +97775,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *629 examples: - default: &631 + default: &633 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -97791,9 +97861,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#create-or-update-an-environment parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 requestBody: required: false content: @@ -97803,7 +97873,7 @@ paths: - object - 'null' properties: - wait_timer: *629 + wait_timer: *631 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -97822,14 +97892,14 @@ paths: items: type: object properties: - type: *626 + type: *628 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *630 + deployment_branch_policy: *632 additionalProperties: false examples: default: @@ -97849,9 +97919,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *629 examples: - default: *631 + default: *633 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -97875,9 +97945,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#delete-an-environment parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 responses: '204': description: Default response @@ -97902,9 +97972,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 - *17 - *19 responses: @@ -97923,7 +97993,7 @@ paths: - 2 branch_policies: type: array - items: &632 + items: &634 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -97984,9 +98054,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 requestBody: required: true content: @@ -98034,9 +98104,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *634 examples: - example-wildcard: &633 + example-wildcard: &635 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -98078,10 +98148,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *472 - - *473 - - *628 - - &634 + - *474 + - *475 + - *630 + - &636 name: branch_policy_id in: path required: true @@ -98093,9 +98163,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *634 examples: - default: *633 + default: *635 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98114,10 +98184,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *472 - - *473 - - *628 - - *634 + - *474 + - *475 + - *630 + - *636 requestBody: required: true content: @@ -98146,9 +98216,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *634 examples: - default: *633 + default: *635 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98167,10 +98237,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *472 - - *473 - - *628 - - *634 + - *474 + - *475 + - *630 + - *636 responses: '204': description: Response @@ -98195,9 +98265,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: - - *628 - - *473 - - *472 + - *630 + - *475 + - *474 responses: '200': description: List of deployment protection rules @@ -98214,7 +98284,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &635 + items: &637 title: Deployment protection rule description: Deployment protection rule type: object @@ -98236,7 +98306,7 @@ paths: for the environment. examples: - true - app: &636 + app: &638 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -98339,9 +98409,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: - - *628 - - *473 - - *472 + - *630 + - *475 + - *474 requestBody: content: application/json: @@ -98362,9 +98432,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *635 + schema: *637 examples: - default: &637 + default: &639 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -98399,9 +98469,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: - - *628 - - *473 - - *472 + - *630 + - *475 + - *474 - *19 - *17 responses: @@ -98421,7 +98491,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *636 + items: *638 examples: default: value: @@ -98456,10 +98526,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: - - *472 - - *473 - - *628 - - &638 + - *474 + - *475 + - *630 + - &640 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -98471,9 +98541,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *637 examples: - default: *637 + default: *639 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98494,10 +98564,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: - - *628 - - *473 - - *472 - - *638 + - *630 + - *475 + - *474 + - *640 responses: '204': description: Response @@ -98523,9 +98593,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-environment-secrets parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 - *17 - *19 responses: @@ -98543,9 +98613,9 @@ paths: type: integer secrets: type: array - items: *502 + items: *504 examples: - default: *503 + default: *505 headers: Link: *45 x-github: @@ -98570,9 +98640,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 responses: '200': description: Response @@ -98602,18 +98672,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-secret parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 - *290 responses: '200': description: Response content: application/json: - schema: *502 + schema: *504 examples: - default: *516 + default: *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98635,9 +98705,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 - *290 requestBody: required: true @@ -98695,9 +98765,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-environment-secret parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 - *290 responses: '204': @@ -98723,9 +98793,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-environment-variables parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 - *299 - *19 responses: @@ -98743,9 +98813,9 @@ paths: type: integer variables: type: array - items: *504 + items: *506 examples: - default: *505 + default: *507 headers: Link: *45 x-github: @@ -98768,9 +98838,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-environment-variable parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 requestBody: required: true content: @@ -98822,18 +98892,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-environment-variable parameters: - - *472 - - *473 - - *628 + - *474 + - *475 + - *630 - *293 responses: '200': description: Response content: application/json: - schema: *504 + schema: *506 examples: - default: *517 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98854,10 +98924,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-environment-variable parameters: - - *472 - - *473 + - *474 + - *475 - *293 - - *628 + - *630 requestBody: required: true content: @@ -98899,10 +98969,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-environment-variable parameters: - - *472 - - *473 + - *474 + - *475 - *293 - - *628 + - *630 responses: '204': description: Response @@ -98924,8 +98994,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-repository-events parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -98993,8 +99063,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#list-forks parameters: - - *472 - - *473 + - *474 + - *475 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -99153,8 +99223,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#create-a-fork parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: false content: @@ -99187,9 +99257,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *479 examples: - default: *479 + default: *481 '400': *14 '422': *15 '403': *27 @@ -99210,8 +99280,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#create-a-blob parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -99271,7 +99341,7 @@ paths: schema: oneOf: - *255 - - *639 + - *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99296,8 +99366,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#get-a-blob parameters: - - *472 - - *473 + - *474 + - *475 - name: file_sha in: path required: true @@ -99397,8 +99467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -99507,7 +99577,7 @@ paths: description: Response content: application/json: - schema: &640 + schema: &642 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -99734,15 +99804,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#get-a-commit-object parameters: - - *472 - - *473 - - *586 + - *474 + - *475 + - *588 responses: '200': description: Response content: application/json: - schema: *640 + schema: *642 examples: default: value: @@ -99798,9 +99868,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#list-matching-references parameters: - - *472 - - *473 - - &641 + - *474 + - *475 + - &643 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. @@ -99817,7 +99887,7 @@ paths: application/json: schema: type: array - items: &642 + items: &644 title: Git Reference description: Git references within a repository type: object @@ -99893,17 +99963,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference parameters: - - *472 - - *473 - - *641 + - *474 + - *475 + - *643 responses: '200': description: Response content: application/json: - schema: *642 + schema: *644 examples: - default: &643 + default: &645 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -99932,8 +100002,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -99962,9 +100032,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *644 examples: - default: *643 + default: *645 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -99990,9 +100060,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference parameters: - - *472 - - *473 - - *641 + - *474 + - *475 + - *643 requestBody: required: true content: @@ -100021,9 +100091,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *644 examples: - default: *643 + default: *645 '422': *15 '409': *119 x-github: @@ -100041,9 +100111,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#delete-a-reference parameters: - - *472 - - *473 - - *641 + - *474 + - *475 + - *643 responses: '204': description: Response @@ -100098,8 +100168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#create-a-tag-object parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -100166,7 +100236,7 @@ paths: description: Response content: application/json: - schema: &645 + schema: &647 title: Git Tag description: Metadata for a Git tag type: object @@ -100222,7 +100292,7 @@ paths: - sha - type - url - verification: *644 + verification: *646 required: - sha - url @@ -100232,7 +100302,7 @@ paths: - tag - message examples: - default: &646 + default: &648 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -100305,8 +100375,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#get-a-tag parameters: - - *472 - - *473 + - *474 + - *475 - name: tag_sha in: path required: true @@ -100317,9 +100387,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *647 examples: - default: *646 + default: *648 '404': *6 '409': *119 x-github: @@ -100343,8 +100413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#create-a-tree parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -100418,7 +100488,7 @@ paths: description: Response content: application/json: - schema: &647 + schema: &649 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -100520,8 +100590,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree parameters: - - *472 - - *473 + - *474 + - *475 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -100544,7 +100614,7 @@ paths: description: Response content: application/json: - schema: *647 + schema: *649 examples: default-response: summary: Default response @@ -100602,8 +100672,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-the-hash-algorithm-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -100647,8 +100717,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-repository-webhooks parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -100658,7 +100728,7 @@ paths: application/json: schema: type: array - items: &648 + items: &650 title: Webhook description: Webhooks for repositories. type: object @@ -100721,7 +100791,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &920 + last_response: &922 title: Hook Response type: object properties: @@ -100798,8 +100868,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#create-a-repository-webhook parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: false content: @@ -100852,9 +100922,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *650 examples: - default: &649 + default: &651 value: type: Repository id: 12345678 @@ -100902,17 +100972,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-repository-webhook parameters: - - *472 - - *473 + - *474 + - *475 - *358 responses: '200': description: Response content: application/json: - schema: *648 + schema: *650 examples: - default: *649 + default: *651 '404': *6 x-github: githubCloudOnly: false @@ -100932,8 +101002,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-repository-webhook parameters: - - *472 - - *473 + - *474 + - *475 - *358 requestBody: required: true @@ -100979,9 +101049,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *650 examples: - default: *649 + default: *651 '422': *15 '404': *6 x-github: @@ -101002,8 +101072,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *472 - - *473 + - *474 + - *475 - *358 responses: '204': @@ -101028,8 +101098,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: - - *472 - - *473 + - *474 + - *475 - *358 responses: '200': @@ -101057,8 +101127,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: - - *472 - - *473 + - *474 + - *475 - *358 requestBody: required: false @@ -101103,8 +101173,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *472 - - *473 + - *474 + - *475 - *358 - *17 - *359 @@ -101137,8 +101207,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: - - *472 - - *473 + - *474 + - *475 - *358 - *16 responses: @@ -101167,8 +101237,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: - - *472 - - *473 + - *474 + - *475 - *358 - *16 responses: @@ -101192,8 +101262,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *472 - - *473 + - *474 + - *475 - *358 responses: '204': @@ -101219,8 +101289,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *472 - - *473 + - *474 + - *475 - *358 responses: '204': @@ -101244,8 +101314,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response if immutable releases are enabled @@ -101293,8 +101363,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-immutable-releases parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': *126 '409': *119 @@ -101314,8 +101384,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-immutable-releases parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': *126 '409': *119 @@ -101372,14 +101442,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-an-import-status parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response content: application/json: - schema: &650 + schema: &652 title: Import description: A repository import from an external source. type: object @@ -101486,7 +101556,7 @@ paths: - html_url - authors_url examples: - default: &653 + default: &655 value: vcs: subversion use_lfs: true @@ -101502,7 +101572,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': &651 + '503': &653 description: Unavailable due to service under maintenance. content: application/json: @@ -101531,8 +101601,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -101580,7 +101650,7 @@ paths: description: Response content: application/json: - schema: *650 + schema: *652 examples: default: value: @@ -101605,7 +101675,7 @@ paths: type: string '422': *15 '404': *6 - '503': *651 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101633,8 +101703,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: false content: @@ -101686,7 +101756,7 @@ paths: description: Response content: application/json: - schema: *650 + schema: *652 examples: example-1: summary: Example 1 @@ -101734,7 +101804,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': *651 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101757,12 +101827,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response - '503': *651 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101788,9 +101858,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-commit-authors parameters: - - *472 - - *473 - - &850 + - *474 + - *475 + - &852 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -101804,7 +101874,7 @@ paths: application/json: schema: type: array - items: &652 + items: &654 title: Porter Author description: Porter Author type: object @@ -101858,7 +101928,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': *651 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101883,8 +101953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author parameters: - - *472 - - *473 + - *474 + - *475 - name: author_id in: path required: true @@ -101914,7 +101984,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *654 examples: default: value: @@ -101927,7 +101997,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *651 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101951,8 +102021,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-large-files parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -101993,7 +102063,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *651 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102021,8 +102091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -102049,11 +102119,11 @@ paths: description: Response content: application/json: - schema: *650 + schema: *652 examples: - default: *653 + default: *655 '422': *15 - '503': *651 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102076,8 +102146,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -102086,7 +102156,7 @@ paths: schema: *20 examples: default: *376 - '301': *478 + '301': *480 '404': *6 x-github: githubCloudOnly: false @@ -102106,8 +102176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -102120,7 +102190,7 @@ paths: properties: {} additionalProperties: false examples: - default: &655 + default: &657 value: limit: collaborators_only origin: repository @@ -102145,13 +102215,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: application/json: - schema: *654 + schema: *656 examples: default: summary: Example request body @@ -102165,7 +102235,7 @@ paths: application/json: schema: *378 examples: - default: *655 + default: *657 '409': description: Response x-github: @@ -102187,8 +102257,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -102215,8 +102285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#get-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -102270,13 +102340,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#add-users-to-the-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: application/json: - schema: &656 + schema: &658 title: Interaction Limits Pull Request Bypass List description: A list of user logins to add or remove from the pull request creation cap bypass list. @@ -102326,13 +102396,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#remove-users-from-the-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: application/json: - schema: *656 + schema: *658 examples: default: summary: Example request body @@ -102362,8 +102432,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -102373,9 +102443,9 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: - default: &843 + default: &845 value: - id: 1 repository: @@ -102506,8 +102576,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *472 - - *473 + - *474 + - *475 - *382 requestBody: required: false @@ -102537,7 +102607,7 @@ paths: description: Response content: application/json: - schema: *657 + schema: *659 examples: default: value: @@ -102668,8 +102738,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *472 - - *473 + - *474 + - *475 - *382 responses: '204': @@ -102693,8 +102763,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/issue-types#list-issue-types-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -102704,7 +102774,7 @@ paths: type: array items: *386 examples: - default: *658 + default: *660 '404': *6 x-github: githubCloudOnly: false @@ -102733,8 +102803,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-repository-issues parameters: - - *472 - - *473 + - *474 + - *475 - 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 @@ -102821,7 +102891,7 @@ paths: type: array items: *221 examples: - default: &669 + default: &671 value: - id: 1 node_id: MDU6SXNzdWUx @@ -102970,7 +103040,7 @@ paths: state_reason: completed headers: Link: *45 - '301': *478 + '301': *480 '422': *15 '404': *6 x-github: @@ -102999,8 +103069,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#create-an-issue parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -103117,7 +103187,7 @@ paths: application/json: schema: *221 examples: - default: &666 + default: &668 value: id: 1 node_id: MDU6SXNzdWUx @@ -103274,7 +103344,7 @@ paths: '422': *15 '503': *195 '404': *6 - '410': *659 + '410': *661 x-github: triggersNotification: true githubCloudOnly: false @@ -103302,8 +103372,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 - *243 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -103326,7 +103396,7 @@ paths: type: array items: *222 examples: - default: &668 + default: &670 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -103385,8 +103455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 responses: '200': @@ -103395,7 +103465,7 @@ paths: application/json: schema: *222 examples: - default: &660 + default: &662 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -103451,8 +103521,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#update-an-issue-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 requestBody: required: true @@ -103477,7 +103547,7 @@ paths: application/json: schema: *222 examples: - default: *660 + default: *662 '422': *15 x-github: githubCloudOnly: false @@ -103495,8 +103565,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#delete-an-issue-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 responses: '204': @@ -103525,8 +103595,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#pin-an-issue-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 responses: '200': @@ -103589,7 +103659,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *659 + '410': *661 '422': *15 x-github: githubCloudOnly: false @@ -103606,8 +103676,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#unpin-an-issue-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 responses: '204': @@ -103615,7 +103685,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *659 + '410': *661 '503': *195 x-github: githubCloudOnly: false @@ -103633,8 +103703,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -103661,9 +103731,9 @@ paths: application/json: schema: type: array - items: *583 + items: *585 examples: - default: *661 + default: *663 headers: Link: *45 '404': *6 @@ -103684,8 +103754,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *472 - - *473 + - *474 + - *475 - *235 requestBody: required: true @@ -103718,16 +103788,16 @@ paths: description: Reaction exists content: application/json: - schema: *583 + schema: *585 examples: - default: *584 + default: *586 '201': description: Reaction created content: application/json: - schema: *583 + schema: *585 examples: - default: *584 + default: *586 '422': *15 x-github: githubCloudOnly: false @@ -103749,10 +103819,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *472 - - *473 + - *474 + - *475 - *235 - - *662 + - *664 responses: '204': description: Response @@ -103772,8 +103842,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -103783,7 +103853,7 @@ paths: application/json: schema: type: array - items: &665 + items: &667 title: Issue Event description: Issue Event type: object @@ -103930,7 +104000,7 @@ paths: required: - from - to - issue_type: &663 + issue_type: &665 title: Issue Type description: The type of issue. type: @@ -103961,11 +104031,11 @@ paths: required: - id - name - prev_issue_type: *663 + prev_issue_type: *665 sub_issue: anyOf: - type: 'null' - - &664 + - &666 title: Issue Reference description: A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency @@ -104023,15 +104093,15 @@ paths: parent_issue: anyOf: - type: 'null' - - *664 + - *666 blocked_by: anyOf: - type: 'null' - - *664 + - *666 blocking: anyOf: - type: 'null' - - *664 + - *666 author_association: *218 lock_reason: type: @@ -104225,8 +104295,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#get-an-issue-event parameters: - - *472 - - *473 + - *474 + - *475 - name: event_id in: path required: true @@ -104237,7 +104307,7 @@ paths: description: Response content: application/json: - schema: *665 + schema: *667 examples: default: value: @@ -104430,7 +104500,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *659 + '410': *661 '403': *27 x-github: githubCloudOnly: false @@ -104464,9 +104534,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue parameters: - - *472 - - *473 - - &667 + - *474 + - *475 + - &669 name: issue_number description: The number that identifies the issue. in: path @@ -104482,7 +104552,7 @@ paths: examples: default: summary: Issue - value: *666 + value: *668 pinned_comment: summary: Issue with pinned comment value: @@ -104681,9 +104751,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *478 + '301': *480 '404': *6 - '410': *659 + '410': *661 '304': *35 x-github: githubCloudOnly: false @@ -104708,9 +104778,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#update-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: false content: @@ -104870,13 +104940,13 @@ paths: - type: object properties: {} examples: - default: *666 + default: *668 '422': *15 '503': *195 '403': *27 - '301': *478 + '301': *480 '404': *6 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104894,9 +104964,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: false content: @@ -104924,7 +104994,7 @@ paths: application/json: schema: *221 examples: - default: *666 + default: *668 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104940,9 +105010,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: content: application/json: @@ -104969,7 +105039,7 @@ paths: application/json: schema: *221 examples: - default: *666 + default: *668 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104991,9 +105061,9 @@ 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: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - name: assignee in: path required: true @@ -105033,9 +105103,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - *226 - *17 - *19 @@ -105048,11 +105118,11 @@ paths: type: array items: *222 examples: - default: *668 + default: *670 headers: Link: *45 '404': *6 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105081,9 +105151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: true content: @@ -105107,14 +105177,14 @@ paths: application/json: schema: *222 examples: - default: *660 + default: *662 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *659 + '410': *661 '422': *15 '404': *6 x-github: @@ -105142,9 +105212,9 @@ 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: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - *17 - *19 responses: @@ -105156,12 +105226,12 @@ paths: type: array items: *221 examples: - default: *669 + default: *671 headers: Link: *45 - '301': *478 + '301': *480 '404': *6 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105189,9 +105259,9 @@ 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: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: true content: @@ -105215,15 +105285,15 @@ paths: application/json: schema: *221 examples: - default: *666 + default: *668 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *478 + '301': *480 '403': *27 - '410': *659 + '410': *661 '422': *15 '404': *6 x-github: @@ -105254,9 +105324,9 @@ 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: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -105270,13 +105340,13 @@ paths: application/json: schema: *221 examples: - default: *666 - '301': *478 + default: *668 + '301': *480 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *659 + '410': *661 x-github: triggersNotification: true githubCloudOnly: false @@ -105302,9 +105372,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - *17 - *19 responses: @@ -105316,12 +105386,12 @@ paths: type: array items: *221 examples: - default: *669 + default: *671 headers: Link: *45 - '301': *478 + '301': *480 '404': *6 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105338,9 +105408,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - *17 - *19 responses: @@ -105354,7 +105424,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &673 + - &675 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -105403,7 +105473,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &674 + - &676 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -105531,7 +105601,7 @@ paths: - performed_via_github_app - assignee - assigner - - &675 + - &677 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -105577,7 +105647,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &676 + - &678 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -105623,7 +105693,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &677 + - &679 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -105672,7 +105742,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &678 + - &680 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -105714,7 +105784,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &679 + - &681 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -105756,7 +105826,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &680 + - &682 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -105812,7 +105882,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &681 + - &683 title: Locked Issue Event description: Locked Issue Event type: object @@ -105857,7 +105927,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &682 + - &684 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -105918,7 +105988,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &683 + - &685 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -105979,7 +106049,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &684 + - &686 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -106040,7 +106110,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &685 + - &687 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -106098,7 +106168,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &688 + - &690 title: Issue Type Added Issue Event description: Issue Type Added Issue Event type: object @@ -106126,7 +106196,7 @@ paths: anyOf: - type: 'null' - *5 - issue_type: *663 + issue_type: *665 required: - issue_type - id @@ -106138,7 +106208,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &689 + - &691 title: Issue Type Removed Issue Event description: Issue Type Removed Issue Event type: object @@ -106166,7 +106236,7 @@ paths: anyOf: - type: 'null' - *5 - prev_issue_type: *663 + prev_issue_type: *665 required: - prev_issue_type - id @@ -106178,7 +106248,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &690 + - &692 title: Issue Type Changed Issue Event description: Issue Type Changed Issue Event type: object @@ -106206,8 +106276,8 @@ paths: anyOf: - type: 'null' - *5 - issue_type: *663 - prev_issue_type: *663 + issue_type: *665 + prev_issue_type: *665 required: - issue_type - prev_issue_type @@ -106220,7 +106290,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &691 + - &693 title: Sub-issue Added Issue Event description: Sub-issue Added Issue Event type: object @@ -106251,7 +106321,7 @@ paths: sub_issue: anyOf: - type: 'null' - - *664 + - *666 required: - sub_issue - id @@ -106263,7 +106333,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &692 + - &694 title: Sub-issue Removed Issue Event description: Sub-issue Removed Issue Event type: object @@ -106294,7 +106364,7 @@ paths: sub_issue: anyOf: - type: 'null' - - *664 + - *666 required: - sub_issue - id @@ -106306,7 +106376,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &693 + - &695 title: Parent-issue Added Issue Event description: Parent-issue Added Issue Event type: object @@ -106337,7 +106407,7 @@ paths: parent_issue: anyOf: - type: 'null' - - *664 + - *666 required: - parent_issue - id @@ -106349,7 +106419,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &694 + - &696 title: Parent-issue Removed Issue Event description: Parent-issue Removed Issue Event type: object @@ -106380,7 +106450,7 @@ paths: parent_issue: anyOf: - type: 'null' - - *664 + - *666 required: - parent_issue - id @@ -106392,7 +106462,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &695 + - &697 title: Blocked-by Added Issue Event description: Blocked-by Added Issue Event type: object @@ -106423,7 +106493,7 @@ paths: blocked_by: anyOf: - type: 'null' - - *664 + - *666 required: - blocked_by - id @@ -106435,7 +106505,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &696 + - &698 title: Blocked-by Removed Issue Event description: Blocked-by Removed Issue Event type: object @@ -106466,7 +106536,7 @@ paths: blocked_by: anyOf: - type: 'null' - - *664 + - *666 required: - blocked_by - id @@ -106478,7 +106548,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &697 + - &699 title: Blocking Added Issue Event description: Blocking Added Issue Event type: object @@ -106509,7 +106579,7 @@ paths: blocking: anyOf: - type: 'null' - - *664 + - *666 required: - blocking - id @@ -106521,7 +106591,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &698 + - &700 title: Blocking Removed Issue Event description: Blocking Removed Issue Event type: object @@ -106552,7 +106622,7 @@ paths: blocking: anyOf: - type: 'null' - - *664 + - *666 required: - blocking - id @@ -106599,7 +106669,7 @@ paths: color: red headers: Link: *45 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106616,9 +106686,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - *17 - *19 responses: @@ -106628,9 +106698,9 @@ paths: application/json: schema: type: array - items: *670 + items: *672 examples: - default: &671 + default: &673 value: - issue_field_id: 1 issue_field_name: DRI @@ -106670,9 +106740,9 @@ paths: color: green headers: Link: *45 - '301': *478 + '301': *480 '404': *6 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106701,9 +106771,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: true content: @@ -106775,9 +106845,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *670 + items: *672 examples: - default: *671 + default: *673 '400': *14 '403': *27 '404': *6 @@ -106813,9 +106883,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: true content: @@ -106882,9 +106952,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *670 + items: *672 examples: - default: *671 + default: *673 '400': *14 '403': *27 '404': *6 @@ -106915,9 +106985,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - *385 responses: '204': @@ -106943,9 +107013,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - *17 - *19 responses: @@ -106957,7 +107027,7 @@ paths: type: array items: *220 examples: - default: &672 + default: &674 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -106975,9 +107045,9 @@ paths: default: false headers: Link: *45 - '301': *478 + '301': *480 '404': *6 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106993,9 +107063,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: false content: @@ -107040,10 +107110,10 @@ paths: type: array items: *220 examples: - default: *672 - '301': *478 + default: *674 + '301': *480 '404': *6 - '410': *659 + '410': *661 '422': *15 x-github: githubCloudOnly: false @@ -107060,9 +107130,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: false content: @@ -107124,10 +107194,10 @@ paths: type: array items: *220 examples: - default: *672 - '301': *478 + default: *674 + '301': *480 '404': *6 - '410': *659 + '410': *661 '422': *15 x-github: githubCloudOnly: false @@ -107144,15 +107214,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 responses: '204': description: Response - '301': *478 + '301': *480 '404': *6 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107171,9 +107241,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - name: name in: path required: true @@ -107197,9 +107267,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *478 + '301': *480 '404': *6 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107219,9 +107289,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#lock-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: false content: @@ -107250,7 +107320,7 @@ paths: '204': description: Response '403': *27 - '410': *659 + '410': *661 '404': *6 '422': *15 x-github: @@ -107268,9 +107338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#unlock-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 responses: '204': description: Response @@ -107300,9 +107370,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#get-parent-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 responses: '200': description: Response @@ -107310,10 +107380,10 @@ paths: application/json: schema: *221 examples: - default: *666 - '301': *478 + default: *668 + '301': *480 '404': *6 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107330,9 +107400,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -107358,13 +107428,13 @@ paths: application/json: schema: type: array - items: *583 + items: *585 examples: - default: *661 + default: *663 headers: Link: *45 '404': *6 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107382,9 +107452,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: true content: @@ -107416,16 +107486,16 @@ paths: description: Response content: application/json: - schema: *583 + schema: *585 examples: - default: *584 + default: *586 '201': description: Response content: application/json: - schema: *583 + schema: *585 examples: - default: *584 + default: *586 '422': *15 x-github: githubCloudOnly: false @@ -107447,10 +107517,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *472 - - *473 - - *667 - - *662 + - *474 + - *475 + - *669 + - *664 responses: '204': description: Response @@ -107479,9 +107549,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#remove-sub-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: true content: @@ -107505,7 +107575,7 @@ paths: application/json: schema: *221 examples: - default: *666 + default: *668 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -107538,9 +107608,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#list-sub-issues parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - *17 - *19 responses: @@ -107552,11 +107622,11 @@ paths: type: array items: *221 examples: - default: *669 + default: *671 headers: Link: *45 '404': *6 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107584,9 +107654,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#add-sub-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: true content: @@ -107615,14 +107685,14 @@ paths: application/json: schema: *221 examples: - default: *666 + default: *668 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *659 + '410': *661 '422': *15 '404': *6 x-github: @@ -107642,9 +107712,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 requestBody: required: true content: @@ -107677,7 +107747,7 @@ paths: application/json: schema: *221 examples: - default: *666 + default: *668 '403': *27 '404': *6 '422': *7 @@ -107699,9 +107769,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *472 - - *473 - - *667 + - *474 + - *475 + - *669 - *17 - *19 responses: @@ -107716,8 +107786,6 @@ paths: description: Timeline Event type: object anyOf: - - *673 - - *674 - *675 - *676 - *677 @@ -107729,6 +107797,8 @@ paths: - *683 - *684 - *685 + - *686 + - *687 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -107785,11 +107855,11 @@ paths: pin: anyOf: - type: 'null' - - *686 + - *688 minimized: anyOf: - type: 'null' - - *687 + - *689 required: - event - actor @@ -108065,7 +108135,7 @@ paths: type: string comments: type: array - items: &719 + items: &721 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -108306,7 +108376,7 @@ paths: type: string comments: type: array - items: *582 + items: *584 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -108426,8 +108496,6 @@ paths: - commit_url - created_at - performed_via_github_app - - *688 - - *689 - *690 - *691 - *692 @@ -108437,6 +108505,8 @@ paths: - *696 - *697 - *698 + - *699 + - *700 examples: default: value: @@ -108593,7 +108663,7 @@ paths: Link: *45 '404': *6 '400': *14 - '410': *659 + '410': *661 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108610,8 +108680,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -108621,7 +108691,7 @@ paths: application/json: schema: type: array - items: &699 + items: &701 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -108689,8 +108759,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -108726,9 +108796,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *701 examples: - default: &700 + default: &702 value: id: 1 key: ssh-rsa AAA... @@ -108762,9 +108832,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *472 - - *473 - - &701 + - *474 + - *475 + - &703 name: key_id description: The unique identifier of the key. in: path @@ -108776,9 +108846,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *701 examples: - default: *700 + default: *702 '404': *6 x-github: githubCloudOnly: false @@ -108796,9 +108866,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *472 - - *473 - - *701 + - *474 + - *475 + - *703 responses: '204': description: Response @@ -108818,8 +108888,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -108831,7 +108901,7 @@ paths: type: array items: *220 examples: - default: *672 + default: *674 headers: Link: *45 '404': *6 @@ -108852,8 +108922,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#create-a-label parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -108891,7 +108961,7 @@ paths: application/json: schema: *220 examples: - default: &702 + default: &704 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -108923,8 +108993,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#get-a-label parameters: - - *472 - - *473 + - *474 + - *475 - name: name in: path required: true @@ -108937,7 +109007,7 @@ paths: application/json: schema: *220 examples: - default: *702 + default: *704 '404': *6 x-github: githubCloudOnly: false @@ -108954,8 +109024,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#update-a-label parameters: - - *472 - - *473 + - *474 + - *475 - name: name in: path required: true @@ -109020,8 +109090,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#delete-a-label parameters: - - *472 - - *473 + - *474 + - *475 - name: name in: path required: true @@ -109047,8 +109117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-languages parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -109084,8 +109154,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '202': *37 '403': @@ -109113,8 +109183,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -109140,9 +109210,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *472 - - *473 - - *557 + - *474 + - *475 + - *559 responses: '200': description: Response @@ -109289,8 +109359,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -109355,8 +109425,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#merge-a-branch parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -109390,9 +109460,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *585 + schema: *587 examples: - default: *703 + default: *705 '204': description: Response when already merged '404': @@ -109417,8 +109487,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#list-milestones parameters: - - *472 - - *473 + - *474 + - *475 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -109515,8 +109585,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#create-a-milestone parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -109558,7 +109628,7 @@ paths: application/json: schema: *420 examples: - default: &704 + default: &706 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -109617,9 +109687,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#get-a-milestone parameters: - - *472 - - *473 - - &705 + - *474 + - *475 + - &707 name: milestone_number description: The number that identifies the milestone. in: path @@ -109633,7 +109703,7 @@ paths: application/json: schema: *420 examples: - default: *704 + default: *706 '404': *6 x-github: githubCloudOnly: false @@ -109650,9 +109720,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#update-a-milestone parameters: - - *472 - - *473 - - *705 + - *474 + - *475 + - *707 requestBody: required: false content: @@ -109692,7 +109762,7 @@ paths: application/json: schema: *420 examples: - default: *704 + default: *706 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109708,9 +109778,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#delete-a-milestone parameters: - - *472 - - *473 - - *705 + - *474 + - *475 + - *707 responses: '204': description: Response @@ -109731,9 +109801,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *472 - - *473 - - *705 + - *474 + - *475 + - *707 - *17 - *19 responses: @@ -109745,7 +109815,7 @@ paths: type: array items: *220 examples: - default: *672 + default: *674 headers: Link: *45 x-github: @@ -109764,12 +109834,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *472 - - *473 - - *706 - - *707 - - *226 + - *474 + - *475 - *708 + - *709 + - *226 + - *710 - *17 - *19 responses: @@ -109781,7 +109851,7 @@ paths: type: array items: *246 examples: - default: *709 + default: *711 headers: Link: *45 x-github: @@ -109805,8 +109875,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: false content: @@ -109864,14 +109934,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-apiname-pages-site parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response content: application/json: - schema: &710 + schema: &712 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -110015,7 +110085,7 @@ paths: - custom_404 - public examples: - default: &711 + default: &713 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -110056,8 +110126,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-apiname-pages-site parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -110112,9 +110182,9 @@ paths: description: Response content: application/json: - schema: *710 + schema: *712 examples: - default: *711 + default: *713 '422': *15 '409': *119 x-github: @@ -110137,8 +110207,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -110246,8 +110316,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -110273,8 +110343,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-apiname-pages-builds parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -110284,7 +110354,7 @@ paths: application/json: schema: type: array - items: &712 + items: &714 title: Page Build description: Page Build type: object @@ -110376,8 +110446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#request-a-apiname-pages-build parameters: - - *472 - - *473 + - *474 + - *475 responses: '201': description: Response @@ -110424,16 +110494,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-latest-pages-build parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response content: application/json: - schema: *712 + schema: *714 examples: - default: &713 + default: &715 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -110481,8 +110551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-apiname-pages-build parameters: - - *472 - - *473 + - *474 + - *475 - name: build_id in: path required: true @@ -110493,9 +110563,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *714 examples: - default: *713 + default: *715 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110515,8 +110585,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-github-pages-deployment parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -110624,9 +110694,9 @@ 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: - - *472 - - *473 - - &714 + - *474 + - *475 + - &716 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -110684,9 +110754,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *472 - - *473 - - *714 + - *474 + - *475 + - *716 responses: '204': *126 '404': *6 @@ -110713,8 +110783,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -111009,8 +111079,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Private vulnerability reporting status @@ -111047,8 +111117,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: - - *472 - - *473 + - *474 + - *475 responses: '204': *126 '422': *14 @@ -111069,8 +111139,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: - - *472 - - *473 + - *474 + - *475 responses: '204': *126 '422': *14 @@ -111092,8 +111162,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -111103,7 +111173,7 @@ paths: type: array items: *155 examples: - default: *715 + default: *717 '403': *27 '404': *6 x-github: @@ -111125,8 +111195,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -111142,7 +111212,7 @@ paths: required: - properties examples: - default: *716 + default: *718 responses: '204': description: No Content when custom property values are successfully created @@ -111180,8 +111250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests parameters: - - *472 - - *473 + - *474 + - *475 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -111241,9 +111311,9 @@ paths: application/json: schema: type: array - items: *589 + items: *591 examples: - default: *717 + default: *719 headers: Link: *45 '304': *35 @@ -111275,8 +111345,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#create-a-pull-request parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -111343,7 +111413,7 @@ paths: description: Response content: application/json: - schema: &721 + schema: &723 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -111577,7 +111647,7 @@ paths: - review_comment - self author_association: *218 - auto_merge: *718 + auto_merge: *720 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -111679,7 +111749,7 @@ paths: - merged_by - review_comments examples: - default: &722 + default: &724 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -112206,8 +112276,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *472 - - *473 + - *474 + - *475 - name: sort in: query required: false @@ -112236,9 +112306,9 @@ paths: application/json: schema: type: array - items: *719 + items: *721 examples: - default: &724 + default: &726 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -112315,17 +112385,17 @@ 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: - - *472 - - *473 + - *474 + - *475 - *235 responses: '200': description: Response content: application/json: - schema: *719 + schema: *721 examples: - default: &720 + default: &722 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -112400,8 +112470,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: - - *472 - - *473 + - *474 + - *475 - *235 requestBody: required: true @@ -112424,9 +112494,9 @@ paths: description: Response content: application/json: - schema: *719 + schema: *721 examples: - default: *720 + default: *722 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -112442,8 +112512,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: - - *472 - - *473 + - *474 + - *475 - *235 responses: '204': @@ -112465,8 +112535,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: - - *472 - - *473 + - *474 + - *475 - *235 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -112493,9 +112563,9 @@ paths: application/json: schema: type: array - items: *583 + items: *585 examples: - default: *661 + default: *663 headers: Link: *45 '404': *6 @@ -112516,8 +112586,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: - - *472 - - *473 + - *474 + - *475 - *235 requestBody: required: true @@ -112550,16 +112620,16 @@ paths: description: Reaction exists content: application/json: - schema: *583 + schema: *585 examples: - default: *584 + default: *586 '201': description: Reaction created content: application/json: - schema: *583 + schema: *585 examples: - default: *584 + default: *586 '422': *15 x-github: githubCloudOnly: false @@ -112581,10 +112651,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *472 - - *473 + - *474 + - *475 - *235 - - *662 + - *664 responses: '204': description: Response @@ -112627,9 +112697,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request parameters: - - *472 - - *473 - - &723 + - *474 + - *475 + - &725 name: pull_number description: The number that identifies the pull request. in: path @@ -112642,9 +112712,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *721 + schema: *723 examples: - default: *722 + default: *724 '304': *35 '404': *6 '406': @@ -112679,9 +112749,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request parameters: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 requestBody: required: false content: @@ -112723,9 +112793,9 @@ paths: description: Response content: application/json: - schema: *721 + schema: *723 examples: - default: *722 + default: *724 '422': *15 '403': *27 x-github: @@ -112747,9 +112817,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 requestBody: required: true content: @@ -112812,7 +112882,7 @@ paths: application/json: schema: *391 examples: - default: *574 + default: *576 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -112820,7 +112890,7 @@ paths: application/json: schema: *391 examples: - default: *574 + default: *576 '401': *23 '403': *27 '404': *6 @@ -112850,9 +112920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 - *243 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -112873,9 +112943,9 @@ paths: application/json: schema: type: array - items: *719 + items: *721 examples: - default: *724 + default: *726 headers: Link: *45 x-github: @@ -112908,9 +112978,9 @@ 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: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 requestBody: required: true content: @@ -113016,7 +113086,7 @@ paths: description: Response content: application/json: - schema: *719 + schema: *721 examples: example-for-a-multi-line-comment: value: @@ -113104,9 +113174,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 - *235 requestBody: required: true @@ -113129,7 +113199,7 @@ paths: description: Response content: application/json: - schema: *719 + schema: *721 examples: default: value: @@ -113215,9 +113285,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 - *17 - *19 responses: @@ -113227,9 +113297,9 @@ paths: application/json: schema: type: array - items: *585 + items: *587 examples: - default: *725 + default: *727 headers: Link: *45 x-github: @@ -113259,9 +113329,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests-files parameters: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 - *17 - *19 responses: @@ -113271,7 +113341,7 @@ paths: application/json: schema: type: array - items: *596 + items: *598 examples: default: value: @@ -113309,9 +113379,9 @@ 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: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 responses: '204': description: Response if pull request has been merged @@ -113334,9 +113404,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#merge-a-pull-request parameters: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 requestBody: required: false content: @@ -113448,9 +113518,9 @@ 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: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 responses: '200': description: Response @@ -113525,9 +113595,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 requestBody: required: false content: @@ -113564,7 +113634,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *591 examples: default: value: @@ -114100,9 +114170,9 @@ 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: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 requestBody: required: true content: @@ -114136,7 +114206,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *591 examples: default: value: @@ -114641,9 +114711,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 - *17 - *19 responses: @@ -114653,7 +114723,7 @@ paths: application/json: schema: type: array - items: &726 + items: &728 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -114809,9 +114879,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 requestBody: required: false content: @@ -114901,9 +114971,9 @@ paths: description: Response content: application/json: - schema: *726 + schema: *728 examples: - default: &728 + default: &730 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -114966,10 +115036,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *472 - - *473 - - *723 - - &727 + - *474 + - *475 + - *725 + - &729 name: review_id description: The unique identifier of the review. in: path @@ -114981,9 +115051,9 @@ paths: description: Response content: application/json: - schema: *726 + schema: *728 examples: - default: &729 + default: &731 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -115042,10 +115112,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *472 - - *473 - - *723 - - *727 + - *474 + - *475 + - *725 + - *729 requestBody: required: true content: @@ -115068,7 +115138,7 @@ paths: description: Response content: application/json: - schema: *726 + schema: *728 examples: default: value: @@ -115130,18 +115200,18 @@ 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: - - *472 - - *473 - - *723 - - *727 + - *474 + - *475 + - *725 + - *729 responses: '200': description: Response content: application/json: - schema: *726 + schema: *728 examples: - default: *728 + default: *730 '422': *7 '404': *6 x-github: @@ -115168,10 +115238,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *472 - - *473 - - *723 - - *727 + - *474 + - *475 + - *725 + - *729 - *17 - *19 responses: @@ -115429,10 +115499,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *472 - - *473 - - *723 - - *727 + - *474 + - *475 + - *725 + - *729 requestBody: required: true content: @@ -115461,7 +115531,7 @@ paths: description: Response content: application/json: - schema: *726 + schema: *728 examples: default: value: @@ -115524,10 +115594,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *472 - - *473 - - *723 - - *727 + - *474 + - *475 + - *725 + - *729 requestBody: required: true content: @@ -115562,9 +115632,9 @@ paths: description: Response content: application/json: - schema: *726 + schema: *728 examples: - default: *729 + default: *731 '404': *6 '422': *7 '403': *27 @@ -115586,9 +115656,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *472 - - *473 - - *723 + - *474 + - *475 + - *725 requestBody: required: false content: @@ -115652,8 +115722,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme parameters: - - *472 - - *473 + - *474 + - *475 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -115666,9 +115736,9 @@ paths: description: Response content: application/json: - schema: *730 + schema: *732 examples: - default: &731 + default: &733 value: type: file encoding: base64 @@ -115710,8 +115780,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: - - *472 - - *473 + - *474 + - *475 - name: dir description: The alternate path to look for a README file in: path @@ -115731,9 +115801,9 @@ paths: description: Response content: application/json: - schema: *730 + schema: *732 examples: - default: *731 + default: *733 '404': *6 '422': *15 x-github: @@ -115755,8 +115825,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#list-releases parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -115766,7 +115836,7 @@ paths: application/json: schema: type: array - items: *732 + items: *734 examples: default: value: @@ -115860,8 +115930,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -115937,9 +116007,9 @@ paths: description: Response content: application/json: - schema: *732 + schema: *734 examples: - default: &736 + default: &738 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -116044,9 +116114,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#get-a-release-asset parameters: - - *472 - - *473 - - &734 + - *474 + - *475 + - &736 name: asset_id description: The unique identifier of the asset. in: path @@ -116058,9 +116128,9 @@ paths: description: Response content: application/json: - schema: *733 + schema: *735 examples: - default: &735 + default: &737 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -116095,7 +116165,7 @@ paths: type: User site_admin: false '404': *6 - '302': *600 + '302': *602 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -116111,9 +116181,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#update-a-release-asset parameters: - - *472 - - *473 - - *734 + - *474 + - *475 + - *736 requestBody: required: false content: @@ -116142,9 +116212,9 @@ paths: description: Response content: application/json: - schema: *733 + schema: *735 examples: - default: *735 + default: *737 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -116160,9 +116230,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#delete-a-release-asset parameters: - - *472 - - *473 - - *734 + - *474 + - *475 + - *736 responses: '204': description: Response @@ -116187,8 +116257,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -116274,16 +116344,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response content: application/json: - schema: *732 + schema: *734 examples: - default: *736 + default: *738 '404': *6 x-github: githubCloudOnly: false @@ -116301,8 +116371,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release-by-tag-name parameters: - - *472 - - *473 + - *474 + - *475 - name: tag description: tag parameter in: path @@ -116315,9 +116385,9 @@ paths: description: Response content: application/json: - schema: *732 + schema: *734 examples: - default: *736 + default: *738 '404': *6 x-github: githubCloudOnly: false @@ -116339,9 +116409,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release parameters: - - *472 - - *473 - - &737 + - *474 + - *475 + - &739 name: release_id description: The unique identifier of the release. in: path @@ -116355,9 +116425,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *732 + schema: *734 examples: - default: *736 + default: *738 '401': description: Unauthorized x-github: @@ -116375,9 +116445,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#update-a-release parameters: - - *472 - - *473 - - *737 + - *474 + - *475 + - *739 requestBody: required: false content: @@ -116441,9 +116511,9 @@ paths: description: Response content: application/json: - schema: *732 + schema: *734 examples: - default: *736 + default: *738 '404': description: Not Found if the discussion category name is invalid content: @@ -116464,9 +116534,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#delete-a-release parameters: - - *472 - - *473 - - *737 + - *474 + - *475 + - *739 responses: '204': description: Response @@ -116487,9 +116557,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets parameters: - - *472 - - *473 - - *737 + - *474 + - *475 + - *739 - *17 - *19 responses: @@ -116499,7 +116569,7 @@ paths: application/json: schema: type: array - items: *733 + items: *735 examples: default: value: @@ -116581,9 +116651,9 @@ 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: - - *472 - - *473 - - *737 + - *474 + - *475 + - *739 - name: name in: query required: true @@ -116609,7 +116679,7 @@ paths: description: Response for successful upload content: application/json: - schema: *733 + schema: *735 examples: response-for-successful-upload: value: @@ -116664,9 +116734,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *472 - - *473 - - *737 + - *474 + - *475 + - *739 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -116690,9 +116760,9 @@ paths: application/json: schema: type: array - items: *583 + items: *585 examples: - default: *661 + default: *663 headers: Link: *45 '404': *6 @@ -116713,9 +116783,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *472 - - *473 - - *737 + - *474 + - *475 + - *739 requestBody: required: true content: @@ -116745,16 +116815,16 @@ paths: description: Reaction exists content: application/json: - schema: *583 + schema: *585 examples: - default: *584 + default: *586 '201': description: Reaction created content: application/json: - schema: *583 + schema: *585 examples: - default: *584 + default: *586 '422': *15 x-github: githubCloudOnly: false @@ -116776,10 +116846,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-release-reaction parameters: - - *472 - - *473 - - *737 - - *662 + - *474 + - *475 + - *739 + - *664 responses: '204': description: Response @@ -116803,9 +116873,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-rules-for-a-branch parameters: - - *472 - - *473 - - *524 + - *474 + - *475 + - *526 - *17 - *19 responses: @@ -116822,7 +116892,7 @@ paths: oneOf: - allOf: - *169 - - &738 + - &740 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -116843,70 +116913,70 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *170 - - *738 + - *740 - allOf: - *171 - - *738 + - *740 - allOf: - *172 - - *738 + - *740 - allOf: - - *739 - - *738 + - *741 + - *740 - allOf: - *173 - - *738 + - *740 - allOf: - *174 - - *738 + - *740 - allOf: - *175 - - *738 + - *740 - allOf: - *176 - - *738 + - *740 - allOf: - *177 - - *738 + - *740 - allOf: - *178 - - *738 + - *740 - allOf: - *179 - - *738 + - *740 - allOf: - *180 - - *738 + - *740 - allOf: - *181 - - *738 + - *740 - allOf: - *182 - - *738 + - *740 - allOf: - *183 - - *738 + - *740 - allOf: - *184 - - *738 + - *740 - allOf: - *185 - - *738 + - *740 - allOf: + - *742 - *740 - - *738 - allOf: - *186 - - *738 + - *740 - allOf: - *187 - - *738 + - *740 - allOf: - *188 - - *738 + - *740 - allOf: - *189 - - *738 + - *740 examples: default: value: @@ -116945,8 +117015,8 @@ paths: category: repos subcategory: rules parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 - name: includes_parents @@ -116957,7 +117027,7 @@ paths: schema: type: boolean default: true - - *741 + - *743 responses: '200': description: Response @@ -117012,8 +117082,8 @@ paths: category: repos subcategory: rules parameters: - - *472 - - *473 + - *474 + - *475 requestBody: description: Request body required: true @@ -117042,7 +117112,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *742 + items: *744 required: - name - enforcement @@ -117075,7 +117145,7 @@ paths: application/json: schema: *190 examples: - default: &752 + default: &754 value: id: 42 name: super cool ruleset @@ -117123,13 +117193,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *472 - - *473 - - *743 - - *105 - - *744 + - *474 + - *475 - *745 + - *105 - *746 + - *747 + - *748 - *17 - *19 responses: @@ -117137,9 +117207,9 @@ paths: description: Response content: application/json: - schema: *747 + schema: *749 examples: - default: *748 + default: *750 '404': *6 '500': *38 x-github: @@ -117160,17 +117230,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *472 - - *473 - - *749 + - *474 + - *475 + - *751 responses: '200': description: Response content: application/json: - schema: *750 + schema: *752 examples: - default: *751 + default: *753 '404': *6 '500': *38 x-github: @@ -117198,8 +117268,8 @@ paths: category: repos subcategory: rules parameters: - - *472 - - *473 + - *474 + - *475 - name: ruleset_id description: The ID of the ruleset. in: path @@ -117221,7 +117291,7 @@ paths: application/json: schema: *190 examples: - default: *752 + default: *754 '404': *6 '500': *38 put: @@ -117239,8 +117309,8 @@ paths: category: repos subcategory: rules parameters: - - *472 - - *473 + - *474 + - *475 - name: ruleset_id description: The ID of the ruleset. in: path @@ -117274,7 +117344,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *742 + items: *744 examples: default: value: @@ -117304,7 +117374,7 @@ paths: application/json: schema: *190 examples: - default: *752 + default: *754 '404': *6 '422': *15 '500': *38 @@ -117323,8 +117393,8 @@ paths: category: repos subcategory: rules parameters: - - *472 - - *473 + - *474 + - *475 - name: ruleset_id description: The ID of the ruleset. in: path @@ -117347,8 +117417,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-history parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 - name: ruleset_id @@ -117385,8 +117455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-version parameters: - - *472 - - *473 + - *474 + - *475 - name: ruleset_id description: The ID of the ruleset. in: path @@ -117459,8 +117529,8 @@ 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: - - *472 - - *473 + - *474 + - *475 - *439 - *440 - *441 @@ -117472,13 +117542,15 @@ paths: - *110 - *19 - *17 - - *753 - - *754 + - *755 + - *756 - *447 - *448 - *449 - *450 - *451 + - *452 + - *453 responses: '200': description: Response @@ -117486,7 +117558,7 @@ paths: application/json: schema: type: array - items: &758 + items: type: object properties: number: *130 @@ -117502,8 +117574,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *755 - resolution: *756 + state: *757 + resolution: *758 resolved_at: type: - string @@ -117609,7 +117681,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *757 + - *759 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -117768,16 +117840,177 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *472 - - *473 - - *551 + - *474 + - *475 + - *553 - *450 responses: '200': description: Response content: application/json: - schema: *758 + schema: &760 + type: object + properties: + number: *130 + created_at: *137 + updated_at: + anyOf: + - type: 'null' + - *138 + url: *135 + html_url: *136 + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: *757 + resolution: *758 + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - *4 + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + provider: + type: + - string + - 'null' + description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret + that was detected. Use this value for filtering by provider + with the `providers` or `exclude_providers` parameters. + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected + secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - *4 + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO + 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection + bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the detected secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple + repositories under the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert + is base64 encoded + first_location_detected: + anyOf: + - type: 'null' + - *759 + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token + in the alert was detected in more than one location. + assigned_to: + anyOf: + - type: 'null' + - *4 + closure_request_comment: + type: + - string + - 'null' + description: An optional comment from the closure request author. + closure_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment from the closure request reviewer. + closure_request_reviewer: + anyOf: + - type: 'null' + - *4 + metadata: &941 + type: array + description: A list of metadata key/value pairs associated with + the secret scanning alert. + readOnly: true + items: + type: object + properties: + key: + type: string + description: The metadata key. + value: + type: string + description: The metadata value. + required: + - key + - value examples: default: value: @@ -117804,6 +118037,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com '304': *35 '404': description: Repository is public, or secret scanning is disabled for the @@ -117831,9 +118067,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: - - *472 - - *473 - - *551 + - *474 + - *475 + - *553 requestBody: required: true content: @@ -117841,8 +118077,8 @@ paths: schema: type: object properties: - state: *755 - resolution: *756 + state: *757 + resolution: *758 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -117890,7 +118126,7 @@ paths: description: Response content: application/json: - schema: *758 + schema: *760 examples: default: value: @@ -117935,6 +118171,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -117989,9 +118228,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: - - *472 - - *473 - - *551 + - *474 + - *475 + - *553 - *19 - *17 responses: @@ -118002,7 +118241,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &940 + items: &943 type: object properties: type: @@ -118029,8 +118268,6 @@ paths: - commit details: oneOf: - - *759 - - *760 - *761 - *762 - *763 @@ -118042,6 +118279,8 @@ paths: - *769 - *770 - *771 + - *772 + - *773 examples: default: value: @@ -118127,8 +118366,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -118136,14 +118375,14 @@ paths: schema: type: object properties: - reason: &773 + reason: &775 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *772 + placeholder_id: *774 required: - reason - placeholder_id @@ -118160,7 +118399,7 @@ paths: schema: type: object properties: - reason: *773 + reason: *775 expire_at: type: - string @@ -118207,8 +118446,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: - - *472 - - *473 + - *474 + - *475 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -118223,7 +118462,7 @@ paths: properties: incremental_scans: type: array - items: &774 + items: &776 description: Information on a single scan performed by secret scanning on the repository type: object @@ -118256,15 +118495,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *774 + items: *776 backfill_scans: type: array - items: *774 + items: *776 custom_pattern_backfill_scans: type: array items: allOf: - - *774 + - *776 - type: object properties: pattern_name: @@ -118277,7 +118516,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *774 + items: *776 examples: default: value: @@ -118342,8 +118581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *472 - - *473 + - *474 + - *475 - *110 - name: sort description: The property to sort the results by. @@ -118387,9 +118626,9 @@ paths: application/json: schema: type: array - items: *775 + items: *777 examples: - default: *776 + default: *778 '400': *14 '404': *6 x-github: @@ -118412,8 +118651,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -118493,7 +118732,7 @@ paths: login: type: string description: The username of the user credited. - type: *456 + type: *458 required: - login - type @@ -118583,9 +118822,9 @@ paths: description: Response content: application/json: - schema: *775 + schema: *777 examples: - default: &778 + default: &780 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -118818,8 +119057,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: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -118932,7 +119171,7 @@ paths: description: Response content: application/json: - schema: *775 + schema: *777 examples: default: value: @@ -119079,17 +119318,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *472 - - *473 - - *777 + - *474 + - *475 + - *779 responses: '200': description: Response content: application/json: - schema: *775 + schema: *777 examples: - default: *778 + default: *780 '403': *27 '404': *6 x-github: @@ -119113,9 +119352,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *472 - - *473 - - *777 + - *474 + - *475 + - *779 requestBody: required: true content: @@ -119195,7 +119434,7 @@ paths: login: type: string description: The username of the user credited. - type: *456 + type: *458 required: - login - type @@ -119286,10 +119525,10 @@ paths: description: Response content: application/json: - schema: *775 + schema: *777 examples: - default: *778 - add_credit: *778 + default: *780 + add_credit: *780 '403': *27 '404': *6 '422': @@ -119327,9 +119566,9 @@ 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: - - *472 - - *473 - - *777 + - *474 + - *475 + - *779 responses: '202': *37 '400': *14 @@ -119356,17 +119595,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: - - *472 - - *473 - - *777 + - *474 + - *475 + - *779 responses: '202': description: Response content: application/json: - schema: *477 + schema: *479 examples: - default: *479 + default: *481 '400': *14 '422': *15 '403': *27 @@ -119392,8 +119631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-stargazers parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -119489,8 +119728,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -119499,7 +119738,7 @@ paths: application/json: schema: type: array - items: &779 + items: &781 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -119532,8 +119771,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -119611,8 +119850,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -119706,8 +119945,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -119861,8 +120100,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: - - *472 - - *473 + - *474 + - *475 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -119872,7 +120111,7 @@ paths: application/json: schema: type: array - items: *779 + items: *781 examples: default: value: @@ -119905,8 +120144,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#create-a-commit-status parameters: - - *472 - - *473 + - *474 + - *475 - name: sha in: path required: true @@ -119962,7 +120201,7 @@ paths: description: Response content: application/json: - schema: *780 + schema: *782 examples: default: value: @@ -120016,8 +120255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-watchers parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -120049,14 +120288,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &781 + schema: &783 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -120129,8 +120368,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: false content: @@ -120156,7 +120395,7 @@ paths: description: Response content: application/json: - schema: *781 + schema: *783 examples: default: value: @@ -120183,8 +120422,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -120204,8 +120443,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -120287,8 +120526,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *472 - - *473 + - *474 + - *475 - name: ref in: path required: true @@ -120324,8 +120563,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-teams parameters: - - *472 - - *473 + - *474 + - *475 - *17 - *19 responses: @@ -120357,8 +120596,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-all-repository-topics parameters: - - *472 - - *473 + - *474 + - *475 - *19 - *17 responses: @@ -120366,7 +120605,7 @@ paths: description: Response content: application/json: - schema: &782 + schema: &784 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -120378,7 +120617,7 @@ paths: required: - names examples: - default: &783 + default: &785 value: names: - octocat @@ -120401,8 +120640,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -120433,9 +120672,9 @@ paths: description: Response content: application/json: - schema: *782 + schema: *784 examples: - default: *783 + default: *785 '404': *6 '422': *7 x-github: @@ -120456,9 +120695,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-repository-clones parameters: - - *472 - - *473 - - &784 + - *474 + - *475 + - &786 name: per description: The time frame to display results for. in: query @@ -120489,7 +120728,7 @@ paths: - 128 clones: type: array - items: &785 + items: &787 title: Traffic type: object properties: @@ -120576,8 +120815,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-paths parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -120671,8 +120910,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-sources parameters: - - *472 - - *473 + - *474 + - *475 responses: '200': description: Response @@ -120735,9 +120974,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-page-views parameters: - - *472 - - *473 - - *784 + - *474 + - *475 + - *786 responses: '200': description: Response @@ -120758,7 +120997,7 @@ paths: - 3782 views: type: array - items: *785 + items: *787 required: - uniques - count @@ -120835,8 +121074,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#transfer-a-repository parameters: - - *472 - - *473 + - *474 + - *475 requestBody: required: true content: @@ -121110,8 +121349,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: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -121134,8 +121373,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-vulnerability-alerts parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -121157,8 +121396,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-vulnerability-alerts parameters: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -121184,8 +121423,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *472 - - *473 + - *474 + - *475 - name: ref in: path required: true @@ -121277,9 +121516,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *479 examples: - default: *479 + default: *481 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -121430,7 +121669,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &793 + - &795 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -121440,7 +121679,7 @@ paths: type: string examples: - members - - &798 + - &800 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -121452,7 +121691,7 @@ paths: format: int32 examples: - 1 - - &799 + - &801 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -121496,7 +121735,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &788 + items: &790 allOf: - type: object required: @@ -121578,7 +121817,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &800 + meta: &802 type: object description: The metadata associated with the creation/updates to the user. @@ -121643,30 +121882,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &789 + '400': &791 description: Bad request content: application/json: - schema: *786 + schema: *788 application/scim+json: - schema: *786 - '401': *787 - '403': &790 + schema: *788 + '401': *789 + '403': &792 description: Permission denied - '429': &791 + '429': &793 description: Too many requests content: application/json: - schema: *786 + schema: *788 application/scim+json: - schema: *786 - '500': &792 + schema: *788 + '500': &794 description: Internal server error content: application/json: - schema: *786 + schema: *788 application/scim+json: - schema: *786 + schema: *788 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -121690,7 +121929,7 @@ paths: required: true content: application/json: - schema: &796 + schema: &798 type: object required: - schemas @@ -121754,9 +121993,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *788 + schema: *790 examples: - group: &794 + group: &796 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -121775,13 +122014,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *789 - '401': *787 - '403': *790 - '409': &797 + '400': *791 + '401': *789 + '403': *792 + '409': &799 description: Duplicate record detected - '429': *791 - '500': *792 + '429': *793 + '500': *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -121798,7 +122037,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &795 + - &797 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -121807,22 +122046,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *793 + - *795 - *39 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *788 + schema: *790 examples: - default: *794 - '400': *789 - '401': *787 - '403': *790 + default: *796 + '400': *791 + '401': *789 + '403': *792 '404': *6 - '429': *791 - '500': *792 + '429': *793 + '500': *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -121841,13 +122080,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *795 + - *797 - *39 requestBody: required: true content: application/json: - schema: *796 + schema: *798 examples: group: summary: Group @@ -121873,17 +122112,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *788 + schema: *790 examples: - group: *794 - groupWithMembers: *794 - '400': *789 - '401': *787 - '403': *790 + group: *796 + groupWithMembers: *796 + '400': *791 + '401': *789 + '403': *792 '404': *6 - '409': *797 - '429': *791 - '500': *792 + '409': *799 + '429': *793 + '500': *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -121907,13 +122146,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *795 + - *797 - *39 requestBody: required: true content: application/json: - schema: &807 + schema: &809 type: object required: - Operations @@ -121973,17 +122212,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *788 + schema: *790 examples: - updateGroup: *794 - addMembers: *794 - '400': *789 - '401': *787 - '403': *790 + updateGroup: *796 + addMembers: *796 + '400': *791 + '401': *789 + '403': *792 '404': *6 - '409': *797 - '429': *791 - '500': *792 + '409': *799 + '429': *793 + '500': *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -121999,17 +122238,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *795 + - *797 - *39 responses: '204': description: Group was deleted, no content - '400': *789 - '401': *787 - '403': *790 + '400': *791 + '401': *789 + '403': *792 '404': *6 - '429': *791 - '500': *792 + '429': *793 + '500': *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -122043,8 +122282,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *798 - - *799 + - *800 + - *801 - *39 responses: '200': @@ -122078,7 +122317,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &802 + items: &804 allOf: - type: object required: @@ -122170,7 +122409,7 @@ paths: address. examples: - true - roles: &801 + roles: &803 type: array description: The roles assigned to the user. items: @@ -122229,7 +122468,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *800 + meta: *802 startIndex: type: integer description: A starting index for the returned page @@ -122268,11 +122507,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *789 - '401': *787 - '403': *790 - '429': *791 - '500': *792 + '400': *791 + '401': *789 + '403': *792 + '429': *793 + '500': *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -122296,7 +122535,7 @@ paths: required: true content: application/json: - schema: &805 + schema: &807 type: object required: - schemas @@ -122389,9 +122628,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *801 + roles: *803 examples: - user: &806 + user: &808 summary: User value: schemas: @@ -122438,9 +122677,9 @@ paths: description: User has been created content: application/scim+json: - schema: *802 + schema: *804 examples: - user: &803 + user: &805 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -122466,13 +122705,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *803 - '400': *789 - '401': *787 - '403': *790 - '409': *797 - '429': *791 - '500': *792 + enterpriseOwner: *805 + '400': *791 + '401': *789 + '403': *792 + '409': *799 + '429': *793 + '500': *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -122489,7 +122728,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &804 + - &806 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -122502,15 +122741,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *802 + schema: *804 examples: - default: *803 - '400': *789 - '401': *787 - '403': *790 + default: *805 + '400': *791 + '401': *789 + '403': *792 '404': *6 - '429': *791 - '500': *792 + '429': *793 + '500': *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -122561,30 +122800,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *804 + - *806 - *39 requestBody: required: true content: application/json: - schema: *805 + schema: *807 examples: - user: *806 + user: *808 responses: '200': description: User was updated content: application/scim+json: - schema: *802 + schema: *804 examples: - user: *803 - '400': *789 - '401': *787 - '403': *790 + user: *805 + '400': *791 + '401': *789 + '403': *792 '404': *6 - '409': *797 - '429': *791 - '500': *792 + '409': *799 + '429': *793 + '500': *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -122625,13 +122864,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *804 + - *806 - *39 requestBody: required: true content: application/json: - schema: *807 + schema: *809 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -122671,18 +122910,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *802 - examples: - userMultiValuedProperties: *803 - userSingleValuedProperties: *803 - disableUser: *803 - '400': *789 - '401': *787 - '403': *790 + schema: *804 + examples: + userMultiValuedProperties: *805 + userSingleValuedProperties: *805 + disableUser: *805 + '400': *791 + '401': *789 + '403': *792 '404': *6 - '409': *797 - '429': *791 - '500': *792 + '409': *799 + '429': *793 + '500': *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -122702,17 +122941,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *804 + - *806 - *39 responses: '204': description: User was deleted, no content - '400': *789 - '401': *787 - '403': *790 + '400': *791 + '401': *789 + '403': *792 '404': *6 - '429': *791 - '500': *792 + '429': *793 + '500': *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -122803,7 +123042,7 @@ paths: - 1 Resources: type: array - items: &808 + items: &810 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -123050,22 +123289,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &809 + '404': &811 description: Resource not found content: application/json: - schema: *786 + schema: *788 application/scim+json: - schema: *786 - '403': &810 + schema: *788 + '403': &812 description: Forbidden content: application/json: - schema: *786 + schema: *788 application/scim+json: - schema: *786 - '400': *789 - '429': *791 + schema: *788 + '400': *791 + '429': *793 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -123091,9 +123330,9 @@ paths: description: Response content: application/scim+json: - schema: *808 + schema: *810 examples: - default: &811 + default: &813 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -123116,17 +123355,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *809 - '403': *810 - '500': *792 + '404': *811 + '403': *812 + '500': *794 '409': description: Conflict content: application/json: - schema: *786 + schema: *788 application/scim+json: - schema: *786 - '400': *789 + schema: *788 + '400': *791 requestBody: required: true content: @@ -123226,17 +123465,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *87 - - *804 + - *806 responses: '200': description: Response content: application/scim+json: - schema: *808 + schema: *810 examples: - default: *811 - '404': *809 - '403': *810 + default: *813 + '404': *811 + '403': *812 '304': *35 x-github: githubCloudOnly: true @@ -123260,18 +123499,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-a-provisioned-organization-membership parameters: - *87 - - *804 + - *806 responses: '200': description: Response content: application/scim+json: - schema: *808 + schema: *810 examples: - default: *811 + default: *813 '304': *35 - '404': *809 - '403': *810 + '404': *811 + '403': *812 requestBody: required: true content: @@ -123386,19 +123625,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *87 - - *804 + - *806 responses: '200': description: Response content: application/scim+json: - schema: *808 + schema: *810 examples: - default: *811 + default: *813 '304': *35 - '404': *809 - '403': *810 - '400': *789 + '404': *811 + '403': *812 + '400': *791 '429': description: Response content: @@ -123494,12 +123733,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *87 - - *804 + - *806 responses: '204': description: Response - '404': *809 - '403': *810 + '404': *811 + '403': *812 '304': *35 x-github: githubCloudOnly: true @@ -123636,7 +123875,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &812 + text_matches: &814 title: Search Result Text Matches type: array items: @@ -123800,7 +124039,7 @@ paths: enum: - author-date - committer-date - - &813 + - &815 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -123869,7 +124108,7 @@ paths: committer: anyOf: - type: 'null' - - *522 + - *524 comment_count: type: integer message: @@ -123888,7 +124127,7 @@ paths: url: type: string format: uri - verification: *644 + verification: *646 required: - author - committer @@ -123903,7 +124142,7 @@ paths: committer: anyOf: - type: 'null' - - *522 + - *524 parents: type: array items: @@ -123920,7 +124159,7 @@ paths: type: number node_id: type: string - text_matches: *812 + text_matches: *814 required: - sha - node_id @@ -124113,7 +124352,7 @@ paths: - interactions - created - updated - - *813 + - *815 - *17 - *19 - name: advanced_search @@ -124227,11 +124466,11 @@ paths: type: - string - 'null' - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: type: string state_reason: @@ -124259,7 +124498,7 @@ paths: - string - 'null' format: date-time - text_matches: *812 + text_matches: *814 pull_request: type: object properties: @@ -124535,7 +124774,7 @@ paths: enum: - created - updated - - *813 + - *815 - *17 - *19 responses: @@ -124580,7 +124819,7 @@ paths: - 'null' score: type: number - text_matches: *812 + text_matches: *814 required: - id - node_id @@ -124666,7 +124905,7 @@ paths: - forks - help-wanted-issues - updated - - *813 + - *815 - *17 - *19 responses: @@ -124912,7 +125151,7 @@ paths: - admin - pull - push - text_matches: *812 + text_matches: *814 temp_clone_token: type: string allow_merge_commit: @@ -125221,7 +125460,7 @@ paths: - string - 'null' format: uri - text_matches: *812 + text_matches: *814 related: type: - array @@ -125416,7 +125655,7 @@ paths: - followers - repositories - joined - - *813 + - *815 - *17 - *19 responses: @@ -125526,7 +125765,7 @@ paths: type: - boolean - 'null' - text_matches: *812 + text_matches: *814 blog: type: - string @@ -125608,7 +125847,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-legacy parameters: - - &816 + - &818 name: team_id description: The unique identifier of the team. in: path @@ -125620,9 +125859,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *466 examples: - default: *465 + default: *467 '404': *6 x-github: githubCloudOnly: false @@ -125649,7 +125888,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team-legacy parameters: - - *816 + - *818 requestBody: required: true content: @@ -125713,16 +125952,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *464 + schema: *466 examples: - default: *465 + default: *467 '201': description: Response content: application/json: - schema: *464 + schema: *466 examples: - default: *465 + default: *467 '404': *6 '422': *15 '403': *27 @@ -125750,7 +125989,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team-legacy parameters: - - *816 + - *818 responses: '204': description: Response @@ -125779,7 +126018,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *816 + - *818 - *17 - *19 responses: @@ -125819,7 +126058,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members-legacy parameters: - - *816 + - *818 - name: role description: Filters members returned by their role in the team. in: query @@ -125840,9 +126079,9 @@ paths: application/json: schema: type: array - items: *817 + items: *819 examples: - default: *818 + default: *820 headers: Link: *45 '404': *6 @@ -125870,7 +126109,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-member-legacy parameters: - - *816 + - *818 - *143 responses: '204': @@ -125907,7 +126146,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-team-member-legacy parameters: - - *816 + - *818 - *143 responses: '204': @@ -125947,7 +126186,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-member-legacy parameters: - - *816 + - *818 - *143 responses: '204': @@ -125984,16 +126223,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *816 + - *818 - *143 responses: '200': description: Response content: application/json: - schema: *471 + schema: *473 examples: - response-if-user-is-a-team-maintainer: *819 + response-if-user-is-a-team-maintainer: *821 '404': *6 x-github: githubCloudOnly: false @@ -126026,7 +126265,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *816 + - *818 - *143 requestBody: required: false @@ -126052,9 +126291,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *473 examples: - response-if-users-membership-with-team-is-now-pending: *820 + response-if-users-membership-with-team-is-now-pending: *822 '403': description: Forbidden if team synchronization is set up '422': @@ -126088,7 +126327,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *816 + - *818 - *143 responses: '204': @@ -126116,7 +126355,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories-legacy parameters: - - *816 + - *818 - *17 - *19 responses: @@ -126158,15 +126397,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *816 - - *472 - - *473 + - *818 + - *474 + - *475 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *821 + schema: *823 examples: alternative-response-with-extra-repository-information: value: @@ -126317,9 +126556,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *816 - - *472 - - *473 + - *818 + - *474 + - *475 requestBody: required: false content: @@ -126369,9 +126608,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *816 - - *472 - - *473 + - *818 + - *474 + - *475 responses: '204': description: Response @@ -126400,15 +126639,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *816 + - *818 responses: '200': description: Response content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '403': *27 '404': *6 x-github: @@ -126435,7 +126674,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *816 + - *818 requestBody: required: true content: @@ -126496,7 +126735,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *476 examples: default: value: @@ -126527,7 +126766,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams-legacy parameters: - - *816 + - *818 - *17 - *19 responses: @@ -126539,7 +126778,7 @@ paths: type: array items: *313 examples: - response-if-child-teams-exist: *822 + response-if-child-teams-exist: *824 headers: Link: *45 '404': *6 @@ -126572,7 +126811,7 @@ paths: application/json: schema: oneOf: - - &824 + - &826 title: Private User description: Private User type: object @@ -126822,7 +127061,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *823 + - *825 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -126982,7 +127221,7 @@ paths: description: Response content: application/json: - schema: *824 + schema: *826 examples: default: value: @@ -127328,7 +127567,7 @@ paths: application/json: schema: *391 examples: - default: *574 + default: *576 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -127336,7 +127575,7 @@ paths: application/json: schema: *391 examples: - default: *574 + default: *576 '401': *23 '403': *27 '404': *6 @@ -127380,7 +127619,7 @@ paths: type: integer secrets: type: array - items: &825 + items: &827 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -127422,7 +127661,7 @@ paths: - visibility - selected_repositories_url examples: - default: *576 + default: *578 headers: Link: *45 x-github: @@ -127500,7 +127739,7 @@ paths: description: Response content: application/json: - schema: *825 + schema: *827 examples: default: value: @@ -127798,7 +128037,7 @@ paths: application/json: schema: *391 examples: - default: *574 + default: *576 '304': *35 '500': *38 '401': *23 @@ -127856,7 +128095,7 @@ paths: application/json: schema: *391 examples: - default: *574 + default: *576 '401': *23 '403': *27 '404': *6 @@ -127913,7 +128152,7 @@ paths: description: Response content: application/json: - schema: &826 + schema: &828 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -127966,7 +128205,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &827 + default: &829 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -128011,9 +128250,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *828 examples: - default: *827 + default: *829 '404': *6 x-github: githubCloudOnly: false @@ -128050,9 +128289,9 @@ paths: type: integer machines: type: array - items: *575 + items: *577 examples: - default: *828 + default: *830 '304': *35 '500': *38 '401': *23 @@ -128137,11 +128376,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *477 + repository: *479 machine: anyOf: - type: 'null' - - *575 + - *577 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -128946,7 +129185,7 @@ paths: application/json: schema: *391 examples: - default: *574 + default: *576 '304': *35 '500': *38 '400': *14 @@ -128986,7 +129225,7 @@ paths: application/json: schema: *391 examples: - default: *574 + default: *576 '500': *38 '401': *23 '403': *27 @@ -129018,7 +129257,7 @@ paths: type: array items: *401 examples: - default: &840 + default: &842 value: - id: 197 name: hello_docker @@ -129119,7 +129358,7 @@ paths: application/json: schema: type: array - items: &829 + items: &831 title: Email description: Email type: object @@ -129189,9 +129428,9 @@ paths: application/json: schema: type: array - items: *829 + items: *831 examples: - default: &842 + default: &844 value: - email: octocat@github.com verified: true @@ -129268,7 +129507,7 @@ paths: application/json: schema: type: array - items: *829 + items: *831 examples: default: value: @@ -129526,7 +129765,7 @@ paths: application/json: schema: type: array - items: &830 + items: &832 title: GPG Key description: A unique encryption key type: object @@ -129671,7 +129910,7 @@ paths: - subkeys - revoked examples: - default: &859 + default: &861 value: - id: 3 name: Octocat's GPG Key @@ -129756,9 +129995,9 @@ paths: description: Response content: application/json: - schema: *830 + schema: *832 examples: - default: &831 + default: &833 value: id: 3 name: Octocat's GPG Key @@ -129815,7 +130054,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &832 + - &834 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -129827,9 +130066,9 @@ paths: description: Response content: application/json: - schema: *830 + schema: *832 examples: - default: *831 + default: *833 '404': *6 '304': *35 '403': *27 @@ -129852,7 +130091,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *832 + - *834 responses: '204': description: Response @@ -130169,7 +130408,7 @@ paths: required: true content: application/json: - schema: *654 + schema: *656 examples: default: value: @@ -130319,7 +130558,7 @@ paths: application/json: schema: type: array - items: &833 + items: &835 title: Key description: Key type: object @@ -130422,9 +130661,9 @@ paths: description: Response content: application/json: - schema: *833 + schema: *835 examples: - default: &834 + default: &836 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -130457,15 +130696,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *701 + - *703 responses: '200': description: Response content: application/json: - schema: *833 + schema: *835 examples: - default: *834 + default: *836 '404': *6 '304': *35 '403': *27 @@ -130488,7 +130727,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *701 + - *703 responses: '204': description: Response @@ -130521,7 +130760,7 @@ paths: application/json: schema: type: array - items: &835 + items: &837 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -130600,7 +130839,7 @@ paths: - account - plan examples: - default: &836 + default: &838 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -130662,9 +130901,9 @@ paths: application/json: schema: type: array - items: *835 + items: *837 examples: - default: *836 + default: *838 headers: Link: *45 '304': *35 @@ -130907,7 +131146,7 @@ paths: application/json: schema: *394 examples: - default: &837 + default: &839 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -130956,7 +131195,7 @@ paths: application/json: schema: *394 examples: - default: *837 + default: *839 '403': *27 '404': *6 '422': *15 @@ -131690,7 +131929,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#unlock-a-user-repository parameters: - *397 - - *838 + - *840 responses: '204': description: Response @@ -131805,7 +132044,7 @@ paths: - docker - nuget - container - - *839 + - *841 - *19 - *17 responses: @@ -131817,8 +132056,8 @@ paths: type: array items: *401 examples: - default: *840 - '400': *841 + default: *842 + '400': *843 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -131847,7 +132086,7 @@ paths: application/json: schema: *401 examples: - default: &860 + default: &862 value: id: 40201 name: octo-name @@ -132209,9 +132448,9 @@ paths: application/json: schema: type: array - items: *829 + items: *831 examples: - default: *842 + default: *844 headers: Link: *45 '304': *35 @@ -132324,7 +132563,7 @@ paths: type: array items: *78 examples: - default: &849 + default: &851 summary: Default response value: - id: 1296269 @@ -132642,9 +132881,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *479 examples: - default: *479 + default: *481 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -132682,9 +132921,9 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: - default: *843 + default: *845 headers: Link: *45 '304': *35 @@ -132763,7 +133002,7 @@ paths: application/json: schema: type: array - items: &844 + items: &846 title: Social account description: Social media account type: object @@ -132780,7 +133019,7 @@ paths: - provider - url examples: - default: &845 + default: &847 value: - provider: twitter url: https://twitter.com/github @@ -132843,9 +133082,9 @@ paths: application/json: schema: type: array - items: *844 + items: *846 examples: - default: *845 + default: *847 '422': *15 '304': *35 '404': *6 @@ -132933,7 +133172,7 @@ paths: application/json: schema: type: array - items: &846 + items: &848 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -132953,7 +133192,7 @@ paths: - title - created_at examples: - default: &874 + default: &876 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -133018,9 +133257,9 @@ paths: description: Response content: application/json: - schema: *846 + schema: *848 examples: - default: &847 + default: &849 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -133050,7 +133289,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &848 + - &850 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -133062,9 +133301,9 @@ paths: description: Response content: application/json: - schema: *846 + schema: *848 examples: - default: *847 + default: *849 '404': *6 '304': *35 '403': *27 @@ -133087,7 +133326,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *848 + - *850 responses: '204': description: Response @@ -133116,7 +133355,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &875 + - &877 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -133141,11 +133380,11 @@ paths: type: array items: *78 examples: - default-response: *849 + default-response: *851 application/vnd.github.v3.star+json: schema: type: array - items: &876 + items: &878 title: Starred Repository description: Starred Repository type: object @@ -133301,8 +133540,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: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response if this repository is starred by you @@ -133330,8 +133569,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: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -133355,8 +133594,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: - - *472 - - *473 + - *474 + - *475 responses: '204': description: Response @@ -133428,7 +133667,7 @@ paths: application/json: schema: type: array - items: *464 + items: *466 examples: default: value: @@ -133514,10 +133753,10 @@ paths: application/json: schema: oneOf: - - *824 - - *823 + - *826 + - *825 examples: - default-response: &853 + default-response: &855 summary: Default response value: login: octocat @@ -133552,7 +133791,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &854 + response-with-git-hub-plan-information: &856 summary: Response with GitHub plan information value: login: octocat @@ -133609,7 +133848,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &851 + - &853 name: user_id description: The unique identifier of the user. in: path @@ -133675,7 +133914,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#list-users parameters: - - *850 + - *852 - *17 responses: '200': @@ -133710,7 +133949,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *851 + - *853 - *419 requestBody: required: true @@ -133785,7 +134024,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *852 + schema: *854 examples: table_view: summary: Response for creating a table view @@ -133837,11 +134076,11 @@ paths: application/json: schema: oneOf: - - *824 - - *823 + - *826 + - *825 examples: - default-response: *853 - response-with-git-hub-plan-information: *854 + default-response: *855 + response-with-git-hub-plan-information: *856 '404': *6 x-github: githubCloudOnly: false @@ -133891,8 +134130,8 @@ paths: required: - subject_digests examples: - default: *855 - withPredicateType: *856 + default: *857 + withPredicateType: *858 responses: '200': description: Response @@ -133946,7 +134185,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *857 + default: *859 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -134151,7 +134390,7 @@ paths: initiator: type: string examples: - default: *518 + default: *520 '201': description: Response content: @@ -134435,7 +134674,7 @@ paths: application/json: schema: *328 examples: - default: &858 + default: &860 summary: Example response for a user copilot space value: id: 42 @@ -134536,7 +134775,7 @@ paths: application/json: schema: *328 examples: - default: *858 + default: *860 '403': *27 '404': *6 x-github: @@ -134662,7 +134901,7 @@ paths: application/json: schema: *328 examples: - default: *858 + default: *860 '403': *27 '404': *6 '422': *15 @@ -135430,7 +135669,7 @@ paths: type: array items: *401 examples: - default: *840 + default: *842 '403': *27 '401': *23 x-github: @@ -135814,9 +136053,9 @@ paths: application/json: schema: type: array - items: *830 + items: *832 examples: - default: *859 + default: *861 headers: Link: *45 x-github: @@ -136045,7 +136284,7 @@ paths: - docker - nuget - container - - *839 + - *841 - *143 - *19 - *17 @@ -136058,10 +136297,10 @@ paths: type: array items: *401 examples: - default: *840 + default: *842 '403': *27 '401': *23 - '400': *841 + '400': *843 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -136091,7 +136330,7 @@ paths: application/json: schema: *401 examples: - default: *860 + default: *862 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -136440,7 +136679,7 @@ paths: type: array items: *422 examples: - default: *861 + default: *863 headers: Link: *45 '304': *35 @@ -136500,7 +136739,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *862 + items: *864 required: - name - data_type @@ -136516,7 +136755,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *863 + iteration_configuration: *865 required: - name - data_type @@ -136538,8 +136777,8 @@ paths: value: name: Due date data_type: date - single_select_field: *864 - iteration_field: *865 + single_select_field: *866 + iteration_field: *867 responses: '201': description: Response @@ -136547,11 +136786,11 @@ paths: application/json: schema: *422 examples: - text_field: *866 - number_field: *867 - date_field: *868 - single_select_field: *869 - iteration_field: *870 + text_field: *868 + number_field: *869 + date_field: *870 + single_select_field: *871 + iteration_field: *872 '304': *35 '403': *27 '401': *23 @@ -136573,7 +136812,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-user parameters: - *419 - - *871 + - *873 - *143 responses: '200': @@ -136582,7 +136821,7 @@ paths: application/json: schema: *422 examples: - default: *872 + default: *874 headers: Link: *45 '304': *35 @@ -136939,7 +137178,7 @@ paths: parameters: - *419 - *143 - - *873 + - *875 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -137218,9 +137457,9 @@ paths: application/json: schema: type: array - items: *844 + items: *846 examples: - default: *845 + default: *847 headers: Link: *45 x-github: @@ -137250,9 +137489,9 @@ paths: application/json: schema: type: array - items: *846 + items: *848 examples: - default: *874 + default: *876 headers: Link: *45 x-github: @@ -137277,7 +137516,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *143 - - *875 + - *877 - *110 - *17 - *19 @@ -137289,11 +137528,11 @@ paths: schema: anyOf: - type: array - items: *876 + items: *878 - type: array items: *78 examples: - default-response: *849 + default-response: *851 headers: Link: *45 x-github: @@ -137453,7 +137692,7 @@ webhooks: type: string enum: - disabled - enterprise: &877 + enterprise: &879 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -137522,7 +137761,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &878 + installation: &880 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -137543,7 +137782,7 @@ webhooks: required: - id - node_id - organization: &879 + organization: &881 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -137616,7 +137855,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &880 + repository: &882 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -138542,10 +138781,10 @@ webhooks: type: string enum: - enabled - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -138621,11 +138860,11 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - rule: &881 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + rule: &883 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -138848,11 +139087,11 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - rule: *881 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + rule: *883 sender: *4 required: - action @@ -139040,11 +139279,11 @@ webhooks: - everyone required: - from - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - rule: *881 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + rule: *883 sender: *4 required: - action @@ -139117,7 +139356,7 @@ webhooks: required: true content: application/json: - schema: &901 + schema: &903 title: Exemption request cancellation event type: object properties: @@ -139125,11 +139364,11 @@ webhooks: type: string enum: - cancelled - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - exemption_request: &882 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + exemption_request: &884 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -139438,7 +139677,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &883 + items: &885 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -139550,7 +139789,7 @@ webhooks: required: true content: application/json: - schema: &902 + schema: &904 title: Exemption request completed event type: object properties: @@ -139558,11 +139797,11 @@ webhooks: type: string enum: - completed - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - exemption_request: *882 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + exemption_request: *884 sender: *4 required: - action @@ -139634,7 +139873,7 @@ webhooks: required: true content: application/json: - schema: &899 + schema: &901 title: Exemption request created event type: object properties: @@ -139642,11 +139881,11 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - exemption_request: *882 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + exemption_request: *884 sender: *4 required: - action @@ -139718,7 +139957,7 @@ webhooks: required: true content: application/json: - schema: &903 + schema: &905 title: Exemption response dismissed event type: object properties: @@ -139726,12 +139965,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - exemption_request: *882 - exemption_response: *883 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + exemption_request: *884 + exemption_response: *885 sender: *4 required: - action @@ -139805,7 +140044,7 @@ webhooks: required: true content: application/json: - schema: &900 + schema: &902 title: Exemption response submitted event type: object properties: @@ -139813,12 +140052,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - exemption_request: *882 - exemption_response: *883 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + exemption_request: *884 + exemption_response: *885 sender: *4 required: - action @@ -139902,7 +140141,7 @@ webhooks: type: string enum: - completed - check_run: &885 + check_run: &887 title: CheckRun description: A check performed on the code of a given code change type: object @@ -140012,7 +140251,7 @@ webhooks: - examples: - neutral - deployment: *884 + deployment: *886 details_url: type: string examples: @@ -140110,10 +140349,10 @@ webhooks: - output - app - pull_requests - installation: *878 - enterprise: *877 - organization: *879 - repository: *880 + installation: *880 + enterprise: *879 + organization: *881 + repository: *882 sender: *4 required: - check_run @@ -140504,11 +140743,11 @@ webhooks: type: string enum: - created - check_run: *885 - installation: *878 - enterprise: *877 - organization: *879 - repository: *880 + check_run: *887 + installation: *880 + enterprise: *879 + organization: *881 + repository: *882 sender: *4 required: - check_run @@ -140902,11 +141141,11 @@ webhooks: type: string enum: - requested_action - check_run: *885 - installation: *878 - enterprise: *877 - organization: *879 - repository: *880 + check_run: *887 + installation: *880 + enterprise: *879 + organization: *881 + repository: *882 requested_action: description: The action requested by the user. type: object @@ -141309,11 +141548,11 @@ webhooks: type: string enum: - rerequested - check_run: *885 - installation: *878 - enterprise: *877 - organization: *879 - repository: *880 + check_run: *887 + installation: *880 + enterprise: *879 + organization: *881 + repository: *882 sender: *4 required: - check_run @@ -142298,10 +142537,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -143015,10 +143254,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -143726,10 +143965,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -143898,7 +144137,7 @@ webhooks: required: - login - id - dismissed_comment: *546 + dismissed_comment: *548 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -144050,20 +144289,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &886 + commit_oid: &888 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *877 - installation: *878 - organization: *879 - ref: &887 + enterprise: *879 + installation: *880 + organization: *881 + ref: &889 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *880 + repository: *882 sender: *4 required: - action @@ -144230,7 +144469,7 @@ webhooks: required: - login - id - dismissed_comment: *546 + dismissed_comment: *548 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -144471,12 +144710,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *886 - enterprise: *877 - installation: *878 - organization: *879 - ref: *887 - repository: *880 + commit_oid: *888 + enterprise: *879 + installation: *880 + organization: *881 + ref: *889 + repository: *882 sender: *4 required: - action @@ -144574,7 +144813,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *546 + dismissed_comment: *548 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -144759,12 +144998,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *886 - enterprise: *877 - installation: *878 - organization: *879 - ref: *887 - repository: *880 + commit_oid: *888 + enterprise: *879 + installation: *880 + organization: *881 + ref: *889 + repository: *882 sender: *4 required: - action @@ -144933,7 +145172,7 @@ webhooks: required: - login - id - dismissed_comment: *546 + dismissed_comment: *548 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -145110,12 +145349,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *886 - enterprise: *877 - installation: *878 - organization: *879 - ref: *887 - repository: *880 + commit_oid: *888 + enterprise: *879 + installation: *880 + organization: *881 + ref: *889 + repository: *882 sender: *4 required: - action @@ -145216,7 +145455,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *546 + dismissed_comment: *548 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -145405,9 +145644,9 @@ webhooks: type: - string - 'null' - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -145415,7 +145654,7 @@ webhooks: type: - string - 'null' - repository: *880 + repository: *882 sender: *4 required: - action @@ -145514,7 +145753,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *546 + dismissed_comment: *548 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -145661,12 +145900,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *886 - enterprise: *877 - installation: *878 - organization: *879 - ref: *887 - repository: *880 + commit_oid: *888 + enterprise: *879 + installation: *880 + organization: *881 + ref: *889 + repository: *882 sender: *4 required: - action @@ -145835,7 +146074,7 @@ webhooks: required: - login - id - dismissed_comment: *546 + dismissed_comment: *548 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -145987,10 +146226,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -146250,10 +146489,10 @@ webhooks: - updated_at - author_association - body - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -146334,18 +146573,18 @@ webhooks: type: - string - 'null' - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *879 - pusher_type: &888 + organization: *881 + pusher_type: &890 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &889 + ref: &891 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource. type: string @@ -146355,7 +146594,7 @@ webhooks: enum: - tag - branch - repository: *880 + repository: *882 sender: *4 required: - ref @@ -146438,9 +146677,9 @@ webhooks: enum: - created definition: *156 - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 sender: *4 required: - action @@ -146525,9 +146764,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 sender: *4 required: - action @@ -146605,9 +146844,9 @@ webhooks: enum: - promote_to_enterprise definition: *156 - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 sender: *4 required: - action @@ -146685,9 +146924,9 @@ webhooks: enum: - updated definition: *156 - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 sender: *4 required: - action @@ -146764,10 +147003,10 @@ webhooks: type: string enum: - updated - enterprise: *877 - installation: *878 - repository: *880 - organization: *879 + enterprise: *879 + installation: *880 + repository: *882 + organization: *881 sender: *4 new_property_values: type: array @@ -146852,18 +147091,18 @@ webhooks: title: delete event type: object properties: - enterprise: *877 - installation: *878 - organization: *879 - pusher_type: *888 - ref: *889 + enterprise: *879 + installation: *880 + organization: *881 + pusher_type: *890 + ref: *891 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *880 + repository: *882 sender: *4 required: - ref @@ -146943,11 +147182,11 @@ webhooks: type: string enum: - assignees_changed - alert: *606 - installation: *878 - organization: *879 - enterprise: *877 - repository: *880 + alert: *608 + installation: *880 + organization: *881 + enterprise: *879 + repository: *882 sender: *4 required: - action @@ -147027,11 +147266,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *606 - installation: *878 - organization: *879 - enterprise: *877 - repository: *880 + alert: *608 + installation: *880 + organization: *881 + enterprise: *879 + repository: *882 sender: *4 required: - action @@ -147112,11 +147351,11 @@ webhooks: type: string enum: - auto_reopened - alert: *606 - installation: *878 - organization: *879 - enterprise: *877 - repository: *880 + alert: *608 + installation: *880 + organization: *881 + enterprise: *879 + repository: *882 sender: *4 required: - action @@ -147197,11 +147436,11 @@ webhooks: type: string enum: - created - alert: *606 - installation: *878 - organization: *879 - enterprise: *877 - repository: *880 + alert: *608 + installation: *880 + organization: *881 + enterprise: *879 + repository: *882 sender: *4 required: - action @@ -147280,11 +147519,11 @@ webhooks: type: string enum: - dismissed - alert: *606 - installation: *878 - organization: *879 - enterprise: *877 - repository: *880 + alert: *608 + installation: *880 + organization: *881 + enterprise: *879 + repository: *882 sender: *4 required: - action @@ -147363,11 +147602,11 @@ webhooks: type: string enum: - fixed - alert: *606 - installation: *878 - organization: *879 - enterprise: *877 - repository: *880 + alert: *608 + installation: *880 + organization: *881 + enterprise: *879 + repository: *882 sender: *4 required: - action @@ -147447,11 +147686,11 @@ webhooks: type: string enum: - reintroduced - alert: *606 - installation: *878 - organization: *879 - enterprise: *877 - repository: *880 + alert: *608 + installation: *880 + organization: *881 + enterprise: *879 + repository: *882 sender: *4 required: - action @@ -147530,11 +147769,11 @@ webhooks: type: string enum: - reopened - alert: *606 - installation: *878 - organization: *879 - enterprise: *877 - repository: *880 + alert: *608 + installation: *880 + organization: *881 + enterprise: *879 + repository: *882 sender: *4 required: - action @@ -147611,9 +147850,9 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - key: &890 + enterprise: *879 + installation: *880 + key: &892 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -147651,8 +147890,8 @@ webhooks: - verified - created_at - read_only - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -147729,11 +147968,11 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - key: *890 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + key: *892 + organization: *881 + repository: *882 sender: *4 required: - action @@ -148300,12 +148539,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 - workflow: &894 + workflow: &896 title: Workflow type: - object @@ -149056,13 +149295,13 @@ webhooks: deployment: anyOf: - type: 'null' - - *613 + - *615 pull_requests: type: array - items: *721 - repository: *880 - organization: *879 - installation: *878 + items: *723 + repository: *882 + organization: *881 + installation: *880 sender: *4 responses: '200': @@ -149133,7 +149372,7 @@ webhooks: type: string enum: - approved - approver: &891 + approver: &893 type: object properties: avatar_url: @@ -149176,11 +149415,11 @@ webhooks: type: string comment: type: string - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - reviewers: &892 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + reviewers: &894 type: array items: type: object @@ -149261,7 +149500,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &893 + workflow_job_run: &895 type: object properties: conclusion: @@ -150007,18 +150246,18 @@ webhooks: type: string enum: - rejected - approver: *891 + approver: *893 comment: type: string - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - reviewers: *892 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + reviewers: *894 sender: *4 since: type: string - workflow_job_run: *893 + workflow_job_run: *895 workflow_job_runs: type: array items: @@ -150735,13 +150974,13 @@ webhooks: type: string enum: - requested - enterprise: *877 + enterprise: *879 environment: type: string - installation: *878 - organization: *879 - repository: *880 - requestor: &904 + installation: *880 + organization: *881 + repository: *882 + requestor: &906 title: User type: - object @@ -152674,12 +152913,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 - workflow: *894 + workflow: *896 workflow_run: title: Deployment Workflow Run type: @@ -153370,7 +153609,7 @@ webhooks: type: string enum: - answered - answer: &897 + answer: &899 type: object properties: author_association: @@ -153530,11 +153769,11 @@ webhooks: - created_at - updated_at - body - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -153661,11 +153900,11 @@ webhooks: - from required: - category - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -153748,11 +153987,11 @@ webhooks: type: string enum: - closed - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -153834,7 +154073,7 @@ webhooks: type: string enum: - created - comment: &896 + comment: &898 type: object properties: author_association: @@ -153994,11 +154233,11 @@ webhooks: - updated_at - body - reactions - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -154081,12 +154320,12 @@ webhooks: type: string enum: - deleted - comment: *896 - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + comment: *898 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -154181,12 +154420,12 @@ webhooks: - from required: - body - comment: *896 - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + comment: *898 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -154270,11 +154509,11 @@ webhooks: type: string enum: - created - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -154356,11 +154595,11 @@ webhooks: type: string enum: - deleted - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -154460,11 +154699,11 @@ webhooks: type: string required: - from - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -154546,10 +154785,10 @@ webhooks: type: string enum: - labeled - discussion: *895 - enterprise: *877 - installation: *878 - label: &898 + discussion: *897 + enterprise: *879 + installation: *880 + label: &900 title: Label type: object properties: @@ -154582,8 +154821,8 @@ webhooks: - color - default - description - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -154666,11 +154905,11 @@ webhooks: type: string enum: - locked - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -154752,11 +154991,11 @@ webhooks: type: string enum: - pinned - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -154838,11 +155077,11 @@ webhooks: type: string enum: - reopened - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -154927,16 +155166,16 @@ webhooks: changes: type: object properties: - new_discussion: *895 - new_repository: *880 + new_discussion: *897 + new_repository: *882 required: - new_discussion - new_repository - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -155019,10 +155258,10 @@ webhooks: type: string enum: - unanswered - discussion: *895 - old_answer: *897 - organization: *879 - repository: *880 + discussion: *897 + old_answer: *899 + organization: *881 + repository: *882 sender: *4 required: - action @@ -155104,12 +155343,12 @@ webhooks: type: string enum: - unlabeled - discussion: *895 - enterprise: *877 - installation: *878 - label: *898 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + label: *900 + organization: *881 + repository: *882 sender: *4 required: - action @@ -155192,11 +155431,11 @@ webhooks: type: string enum: - unlocked - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -155278,11 +155517,11 @@ webhooks: type: string enum: - unpinned - discussion: *895 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + discussion: *897 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -155351,7 +155590,7 @@ webhooks: required: true content: application/json: - schema: *899 + schema: *901 responses: '200': description: Return a 200 status to indicate that the data was received @@ -155414,7 +155653,7 @@ webhooks: required: true content: application/json: - schema: *900 + schema: *902 responses: '200': description: Return a 200 status to indicate that the data was received @@ -155477,7 +155716,7 @@ webhooks: required: true content: application/json: - schema: *901 + schema: *903 responses: '200': description: Return a 200 status to indicate that the data was received @@ -155540,7 +155779,7 @@ webhooks: required: true content: application/json: - schema: *899 + schema: *901 responses: '200': description: Return a 200 status to indicate that the data was received @@ -155603,7 +155842,7 @@ webhooks: required: true content: application/json: - schema: *900 + schema: *902 responses: '200': description: Return a 200 status to indicate that the data was received @@ -155669,7 +155908,7 @@ webhooks: required: true content: application/json: - schema: *901 + schema: *903 responses: '200': description: Return a 200 status to indicate that the data was received @@ -155735,7 +155974,7 @@ webhooks: required: true content: application/json: - schema: *902 + schema: *904 responses: '200': description: Return a 200 status to indicate that the data was received @@ -155801,7 +156040,7 @@ webhooks: required: true content: application/json: - schema: *899 + schema: *901 responses: '200': description: Return a 200 status to indicate that the data was received @@ -155867,7 +156106,7 @@ webhooks: required: true content: application/json: - schema: *903 + schema: *905 responses: '200': description: Return a 200 status to indicate that the data was received @@ -155933,7 +156172,7 @@ webhooks: required: true content: application/json: - schema: *900 + schema: *902 responses: '200': description: Return a 200 status to indicate that the data was received @@ -155998,7 +156237,7 @@ webhooks: required: true content: application/json: - schema: *901 + schema: *903 responses: '200': description: Return a 200 status to indicate that the data was received @@ -156063,7 +156302,7 @@ webhooks: required: true content: application/json: - schema: *902 + schema: *904 responses: '200': description: Return a 200 status to indicate that the data was received @@ -156128,7 +156367,7 @@ webhooks: required: true content: application/json: - schema: *899 + schema: *901 responses: '200': description: Return a 200 status to indicate that the data was received @@ -156193,7 +156432,7 @@ webhooks: required: true content: application/json: - schema: *903 + schema: *905 responses: '200': description: Return a 200 status to indicate that the data was received @@ -156259,7 +156498,7 @@ webhooks: required: true content: application/json: - schema: *900 + schema: *902 responses: '200': description: Return a 200 status to indicate that the data was received @@ -156326,7 +156565,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *877 + enterprise: *879 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) resource. @@ -157004,9 +157243,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *878 - organization: *879 - repository: *880 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - forkee @@ -157152,9 +157391,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 pages: description: The pages that were updated. type: array @@ -157192,7 +157431,7 @@ webhooks: - action - sha - html_url - repository: *880 + repository: *882 sender: *4 required: - pages @@ -157268,10 +157507,10 @@ webhooks: type: string enum: - created - enterprise: *877 + enterprise: *879 installation: *20 - organization: *879 - repositories: &905 + organization: *881 + repositories: &907 description: An array of repository objects that the installation can access. type: array @@ -157297,8 +157536,8 @@ webhooks: - name - full_name - private - repository: *880 - requester: *904 + repository: *882 + requester: *906 sender: *4 required: - action @@ -157373,11 +157612,11 @@ webhooks: type: string enum: - deleted - enterprise: *877 + enterprise: *879 installation: *20 - organization: *879 - repositories: *905 - repository: *880 + organization: *881 + repositories: *907 + repository: *882 requester: type: - 'null' @@ -157454,11 +157693,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *877 + enterprise: *879 installation: *20 - organization: *879 - repositories: *905 - repository: *880 + organization: *881 + repositories: *907 + repository: *882 requester: type: - 'null' @@ -157535,10 +157774,10 @@ webhooks: type: string enum: - added - enterprise: *877 + enterprise: *879 installation: *20 - organization: *879 - repositories_added: &906 + organization: *881 + repositories_added: &908 description: An array of repository objects, which were added to the installation. type: array @@ -157584,15 +157823,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *880 - repository_selection: &907 + repository: *882 + repository_selection: &909 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *904 + requester: *906 sender: *4 required: - action @@ -157671,10 +157910,10 @@ webhooks: type: string enum: - removed - enterprise: *877 + enterprise: *879 installation: *20 - organization: *879 - repositories_added: *906 + organization: *881 + repositories_added: *908 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -157701,9 +157940,9 @@ webhooks: - name - full_name - private - repository: *880 - repository_selection: *907 - requester: *904 + repository: *882 + repository_selection: *909 + requester: *906 sender: *4 required: - action @@ -157782,11 +158021,11 @@ webhooks: type: string enum: - suspend - enterprise: *877 + enterprise: *879 installation: *20 - organization: *879 - repositories: *905 - repository: *880 + organization: *881 + repositories: *907 + repository: *882 requester: type: - 'null' @@ -157969,10 +158208,10 @@ webhooks: type: string required: - from - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 target_type: type: string @@ -158051,11 +158290,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *877 + enterprise: *879 installation: *20 - organization: *879 - repositories: *905 - repository: *880 + organization: *881 + repositories: *907 + repository: *882 requester: type: - 'null' @@ -158221,11 +158460,11 @@ webhooks: pin: anyOf: - type: 'null' - - *686 + - *688 minimized: anyOf: - type: 'null' - - *687 + - *689 user: title: User type: @@ -158311,8 +158550,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -159124,8 +159363,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159486,8 +159725,8 @@ webhooks: - state - locked - assignee - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -159567,7 +159806,7 @@ webhooks: type: string enum: - deleted - comment: &908 + comment: &910 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself. @@ -159724,11 +159963,11 @@ webhooks: pin: anyOf: - type: 'null' - - *686 + - *688 minimized: anyOf: - type: 'null' - - *687 + - *689 required: - url - html_url @@ -159742,8 +159981,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -160551,8 +160790,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160915,8 +161154,8 @@ webhooks: - state - locked - assignee - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -160996,7 +161235,7 @@ webhooks: type: string enum: - edited - changes: &932 + changes: &934 description: The changes to the comment. type: object properties: @@ -161008,9 +161247,9 @@ webhooks: type: string required: - from - comment: *908 - enterprise: *877 - installation: *878 + comment: *910 + enterprise: *879 + installation: *880 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -161821,8 +162060,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162183,8 +162422,8 @@ webhooks: - state - locked - assignee - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -162265,9 +162504,9 @@ webhooks: type: string enum: - pinned - comment: *908 - enterprise: *877 - installation: *878 + comment: *910 + enterprise: *879 + installation: *880 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -163080,8 +163319,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 state: description: State of the issue; either 'open' or 'closed' type: string @@ -163444,8 +163683,8 @@ webhooks: - state - locked - assignee - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -163525,9 +163764,9 @@ webhooks: type: string enum: - unpinned - comment: *908 - enterprise: *877 - installation: *878 + comment: *910 + enterprise: *879 + installation: *880 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -164340,8 +164579,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 state: description: State of the issue; either 'open' or 'closed' type: string @@ -164704,8 +164943,8 @@ webhooks: - state - locked - assignee - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -164794,9 +165033,9 @@ webhooks: type: number blocking_issue: *221 blocking_issue_repo: *78 - installation: *878 - organization: *879 - repository: *880 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -164885,9 +165124,9 @@ webhooks: type: number blocking_issue: *221 blocking_issue_repo: *78 - installation: *878 - organization: *879 - repository: *880 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -164975,9 +165214,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *221 - installation: *878 - organization: *879 - repository: *880 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -165066,9 +165305,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *221 - installation: *878 - organization: *879 - repository: *880 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -165148,10 +165387,10 @@ webhooks: type: string enum: - assigned - assignee: *904 - enterprise: *877 - installation: *878 - issue: &909 + assignee: *906 + enterprise: *879 + installation: *880 + issue: &911 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -165962,11 +166201,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -166086,8 +166325,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -166167,8 +166406,8 @@ webhooks: type: string enum: - closed - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -166984,11 +167223,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -167251,8 +167490,8 @@ webhooks: required: - state - closed_at - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -167331,8 +167570,8 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -168139,11 +168378,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -168262,8 +168501,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -168342,8 +168581,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -169173,11 +169412,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -169275,7 +169514,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &910 + milestone: &912 title: Milestone description: A collection of related issues and pull requests. type: object @@ -169418,8 +169657,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -169518,8 +169757,8 @@ webhooks: type: string required: - from - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -170330,11 +170569,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -170454,9 +170693,9 @@ webhooks: - active_lock_reason - body - reactions - label: *898 - organization: *879 - repository: *880 + label: *900 + organization: *881 + repository: *882 sender: *4 required: - action @@ -170536,9 +170775,9 @@ webhooks: type: string enum: - field_added - enterprise: *877 - installation: *878 - issue: *909 + enterprise: *879 + installation: *880 + issue: *911 issue_field: type: object description: The issue field whose value was set or updated on the @@ -170704,8 +170943,8 @@ webhooks: - id required: - from - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -170785,9 +171024,9 @@ webhooks: type: string enum: - field_removed - enterprise: *877 - installation: *878 - issue: *909 + enterprise: *879 + installation: *880 + issue: *911 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -170874,8 +171113,8 @@ webhooks: - 'null' required: - id - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -170955,8 +171194,8 @@ webhooks: type: string enum: - labeled - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -171766,11 +172005,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -171890,9 +172129,9 @@ webhooks: - active_lock_reason - body - reactions - label: *898 - organization: *879 - repository: *880 + label: *900 + organization: *881 + repository: *882 sender: *4 required: - action @@ -171972,8 +172211,8 @@ webhooks: type: string enum: - locked - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -172808,11 +173047,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -172909,8 +173148,8 @@ webhooks: format: uri user_view_type: type: string - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -172989,8 +173228,8 @@ webhooks: type: string enum: - milestoned - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -173819,11 +174058,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -173920,9 +174159,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *910 - organization: *879 - repository: *880 + milestone: *912 + organization: *881 + repository: *882 sender: *4 required: - action @@ -174809,11 +175048,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -175405,8 +175644,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -176213,11 +176452,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -176340,8 +176579,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -176421,9 +176660,9 @@ webhooks: type: string enum: - pinned - enterprise: *877 - installation: *878 - issue: &911 + enterprise: *879 + installation: *880 + issue: &913 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -177228,11 +177467,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -177351,8 +177590,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -177431,8 +177670,8 @@ webhooks: type: string enum: - reopened - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -178265,11 +178504,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -178367,8 +178606,8 @@ webhooks: user_view_type: type: string type: *386 - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -179256,11 +179495,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -179870,11 +180109,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *877 - installation: *878 - issue: *911 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + issue: *913 + organization: *881 + repository: *882 sender: *4 required: - action @@ -179954,12 +180193,12 @@ webhooks: type: string enum: - typed - enterprise: *877 - installation: *878 - issue: *909 + enterprise: *879 + installation: *880 + issue: *911 type: *386 - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -180040,7 +180279,7 @@ webhooks: type: string enum: - unassigned - assignee: &935 + assignee: &937 title: User type: - object @@ -180112,11 +180351,11 @@ webhooks: required: - login - id - enterprise: *877 - installation: *878 - issue: *909 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + issue: *911 + organization: *881 + repository: *882 sender: *4 required: - action @@ -180195,12 +180434,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *877 - installation: *878 - issue: *909 - label: *898 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + issue: *911 + label: *900 + organization: *881 + repository: *882 sender: *4 required: - action @@ -180280,8 +180519,8 @@ webhooks: type: string enum: - unlocked - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -181114,11 +181353,11 @@ webhooks: anyOf: - type: 'null' - *222 - sub_issues_summary: *814 - issue_dependencies_summary: *815 + sub_issues_summary: *816 + issue_dependencies_summary: *817 issue_field_values: type: array - items: *670 + items: *672 state: description: State of the issue; either 'open' or 'closed' type: string @@ -181215,8 +181454,8 @@ webhooks: format: uri user_view_type: type: string - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -181296,11 +181535,11 @@ webhooks: type: string enum: - unpinned - enterprise: *877 - installation: *878 - issue: *911 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + issue: *913 + organization: *881 + repository: *882 sender: *4 required: - action @@ -181379,12 +181618,12 @@ webhooks: type: string enum: - untyped - enterprise: *877 - installation: *878 - issue: *909 + enterprise: *879 + installation: *880 + issue: *911 type: *386 - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -181464,11 +181703,11 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - label: *898 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + label: *900 + organization: *881 + repository: *882 sender: *4 required: - action @@ -181546,11 +181785,11 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - label: *898 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + label: *900 + organization: *881 + repository: *882 sender: *4 required: - action @@ -181660,11 +181899,11 @@ webhooks: type: string required: - from - enterprise: *877 - installation: *878 - label: *898 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + label: *900 + organization: *881 + repository: *882 sender: *4 required: - action @@ -181746,9 +181985,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *877 - installation: *878 - marketplace_purchase: &912 + enterprise: *879 + installation: *880 + marketplace_purchase: &914 title: Marketplace Purchase type: object required: @@ -181836,8 +182075,8 @@ webhooks: type: integer unit_count: type: integer - organization: *879 - previous_marketplace_purchase: &913 + organization: *881 + previous_marketplace_purchase: &915 title: Marketplace Purchase type: object properties: @@ -181921,7 +182160,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *880 + repository: *882 sender: *4 required: - action @@ -182001,10 +182240,10 @@ webhooks: - changed effective_date: type: string - enterprise: *877 - installation: *878 - marketplace_purchase: *912 - organization: *879 + enterprise: *879 + installation: *880 + marketplace_purchase: *914 + organization: *881 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -182092,7 +182331,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *880 + repository: *882 sender: *4 required: - action @@ -182174,10 +182413,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *877 - installation: *878 - marketplace_purchase: *912 - organization: *879 + enterprise: *879 + installation: *880 + marketplace_purchase: *914 + organization: *881 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -182263,7 +182502,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *880 + repository: *882 sender: *4 required: - action @@ -182344,8 +182583,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 marketplace_purchase: title: Marketplace Purchase type: object @@ -182431,9 +182670,9 @@ webhooks: type: integer unit_count: type: integer - organization: *879 - previous_marketplace_purchase: *913 - repository: *880 + organization: *881 + previous_marketplace_purchase: *915 + repository: *882 sender: *4 required: - action @@ -182513,12 +182752,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *877 - installation: *878 - marketplace_purchase: *912 - organization: *879 - previous_marketplace_purchase: *913 - repository: *880 + enterprise: *879 + installation: *880 + marketplace_purchase: *914 + organization: *881 + previous_marketplace_purchase: *915 + repository: *882 sender: *4 required: - action @@ -182620,11 +182859,11 @@ webhooks: type: string required: - to - enterprise: *877 - installation: *878 - member: *904 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + member: *906 + organization: *881 + repository: *882 sender: *4 required: - action @@ -182726,11 +182965,11 @@ webhooks: type: - string - 'null' - enterprise: *877 - installation: *878 - member: *904 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + member: *906 + organization: *881 + repository: *882 sender: *4 required: - action @@ -182809,11 +183048,11 @@ webhooks: type: string enum: - removed - enterprise: *877 - installation: *878 - member: *904 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + member: *906 + organization: *881 + repository: *882 sender: *4 required: - action @@ -182891,11 +183130,11 @@ webhooks: type: string enum: - added - enterprise: *877 - installation: *878 - member: *904 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + member: *906 + organization: *881 + repository: *882 scope: description: The scope of the membership. Currently, can only be `team`. @@ -182973,7 +183212,7 @@ webhooks: required: - login - id - team: &914 + team: &916 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -183203,11 +183442,11 @@ webhooks: type: string enum: - removed - enterprise: *877 - installation: *878 - member: *904 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + member: *906 + organization: *881 + repository: *882 scope: description: The scope of the membership. Currently, can only be `team`. @@ -183286,7 +183525,7 @@ webhooks: required: - login - id - team: *914 + team: *916 required: - action - scope @@ -183368,8 +183607,8 @@ webhooks: type: string enum: - checks_requested - installation: *878 - merge_group: &915 + installation: *880 + merge_group: &917 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -183388,15 +183627,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *538 + head_commit: *540 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -183482,10 +183721,10 @@ webhooks: - merged - invalidated - dequeued - installation: *878 - merge_group: *915 - organization: *879 - repository: *880 + installation: *880 + merge_group: *917 + organization: *881 + repository: *882 sender: *4 required: - action @@ -183558,7 +183797,7 @@ webhooks: type: string enum: - deleted - enterprise: *877 + enterprise: *879 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -183667,12 +183906,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *878 - organization: *879 + installation: *880 + organization: *881 repository: anyOf: - type: 'null' - - *880 + - *882 sender: *4 required: - action @@ -183752,11 +183991,11 @@ webhooks: type: string enum: - closed - enterprise: *877 - installation: *878 - milestone: *910 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + milestone: *912 + organization: *881 + repository: *882 sender: *4 required: - action @@ -183835,9 +184074,9 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - milestone: &916 + enterprise: *879 + installation: *880 + milestone: &918 title: Milestone description: A collection of related issues and pull requests. type: object @@ -183979,8 +184218,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -184059,11 +184298,11 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - milestone: *910 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + milestone: *912 + organization: *881 + repository: *882 sender: *4 required: - action @@ -184173,11 +184412,11 @@ webhooks: type: string required: - from - enterprise: *877 - installation: *878 - milestone: *910 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + milestone: *912 + organization: *881 + repository: *882 sender: *4 required: - action @@ -184257,11 +184496,11 @@ webhooks: type: string enum: - opened - enterprise: *877 - installation: *878 - milestone: *916 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + milestone: *918 + organization: *881 + repository: *882 sender: *4 required: - action @@ -184340,11 +184579,11 @@ webhooks: type: string enum: - blocked - blocked_user: *904 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + blocked_user: *906 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -184423,11 +184662,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *904 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + blocked_user: *906 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -184503,7 +184742,7 @@ webhooks: enum: - created definition: *151 - enterprise: *877 + enterprise: *879 sender: *4 required: - action @@ -184583,8 +184822,8 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 sender: *4 required: - action @@ -184657,8 +184896,8 @@ webhooks: enum: - updated definition: *151 - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 sender: *4 required: - action @@ -184730,9 +184969,9 @@ webhooks: type: string enum: - updated - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 sender: *4 new_property_values: type: array @@ -184820,9 +185059,9 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - membership: &917 + enterprise: *879 + installation: *880 + membership: &919 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -184932,8 +185171,8 @@ webhooks: - role - organization_url - user - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -185011,11 +185250,11 @@ webhooks: type: string enum: - member_added - enterprise: *877 - installation: *878 - membership: *917 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + membership: *919 + organization: *881 + repository: *882 sender: *4 required: - action @@ -185094,8 +185333,8 @@ webhooks: type: string enum: - member_invited - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -185217,10 +185456,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 - user: *904 + user: *906 required: - action - invitation @@ -185298,11 +185537,11 @@ webhooks: type: string enum: - member_removed - enterprise: *877 - installation: *878 - membership: *917 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + membership: *919 + organization: *881 + repository: *882 sender: *4 required: - action @@ -185389,11 +185628,11 @@ webhooks: properties: from: type: string - enterprise: *877 - installation: *878 - membership: *917 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + membership: *919 + organization: *881 + repository: *882 sender: *4 required: - action @@ -185471,9 +185710,9 @@ webhooks: type: string enum: - published - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 package: description: Information about the package. type: object @@ -185996,7 +186235,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &918 + items: &920 title: Ruby Gems metadata type: object properties: @@ -186093,7 +186332,7 @@ webhooks: - owner - package_version - registry - repository: *880 + repository: *882 sender: *4 required: - action @@ -186170,9 +186409,9 @@ webhooks: type: string enum: - updated - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 package: description: Information about the package. type: object @@ -186534,7 +186773,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *918 + items: *920 source_url: type: string format: uri @@ -186605,7 +186844,7 @@ webhooks: - owner - package_version - registry - repository: *880 + repository: *882 sender: *4 required: - action @@ -186785,12 +187024,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *877 + enterprise: *879 id: type: integer - installation: *878 - organization: *879 - repository: *880 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - id @@ -186867,7 +187106,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &919 + personal_access_token_request: &921 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -187017,10 +187256,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *877 - organization: *879 + enterprise: *879 + organization: *881 sender: *4 - installation: *878 + installation: *880 required: - action - personal_access_token_request @@ -187097,11 +187336,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *919 - enterprise: *877 - organization: *879 + personal_access_token_request: *921 + enterprise: *879 + organization: *881 sender: *4 - installation: *878 + installation: *880 required: - action - personal_access_token_request @@ -187177,11 +187416,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *919 - enterprise: *877 - organization: *879 + personal_access_token_request: *921 + enterprise: *879 + organization: *881 sender: *4 - installation: *878 + installation: *880 required: - action - personal_access_token_request @@ -187256,11 +187495,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *919 - organization: *879 - enterprise: *877 + personal_access_token_request: *921 + organization: *881 + enterprise: *879 sender: *4 - installation: *878 + installation: *880 required: - action - personal_access_token_request @@ -187365,7 +187604,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *920 + last_response: *922 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -187397,8 +187636,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 zen: description: Random string of GitHub zen. @@ -187643,10 +187882,10 @@ webhooks: - from required: - note - enterprise: *877 - installation: *878 - organization: *879 - project_card: &921 + enterprise: *879 + installation: *880 + organization: *881 + project_card: &923 title: Project Card type: object properties: @@ -187769,7 +188008,7 @@ webhooks: - creator - created_at - updated_at - repository: *880 + repository: *882 sender: *4 required: - action @@ -187850,11 +188089,11 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - organization: *879 - project_card: *921 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + project_card: *923 + repository: *882 sender: *4 required: - action @@ -187934,9 +188173,9 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 project_card: title: Project Card type: object @@ -188066,7 +188305,7 @@ webhooks: repository: anyOf: - type: 'null' - - *880 + - *882 sender: *4 required: - action @@ -188160,11 +188399,11 @@ webhooks: - from required: - note - enterprise: *877 - installation: *878 - organization: *879 - project_card: *921 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + project_card: *923 + repository: *882 sender: *4 required: - action @@ -188258,9 +188497,9 @@ webhooks: - from required: - column_id - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 project_card: allOf: - title: Project Card @@ -188457,7 +188696,7 @@ webhooks: type: string required: - after_id - repository: *880 + repository: *882 sender: *4 required: - action @@ -188537,10 +188776,10 @@ webhooks: type: string enum: - closed - enterprise: *877 - installation: *878 - organization: *879 - project: &923 + enterprise: *879 + installation: *880 + organization: *881 + project: &925 title: Project type: object properties: @@ -188667,7 +188906,7 @@ webhooks: - creator - created_at - updated_at - repository: *880 + repository: *882 sender: *4 required: - action @@ -188747,10 +188986,10 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - organization: *879 - project_column: &922 + enterprise: *879 + installation: *880 + organization: *881 + project_column: &924 title: Project Column type: object properties: @@ -188790,7 +189029,7 @@ webhooks: - name - created_at - updated_at - repository: *880 + repository: *882 sender: *4 required: - action @@ -188869,14 +189108,14 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - organization: *879 - project_column: *922 + enterprise: *879 + installation: *880 + organization: *881 + project_column: *924 repository: anyOf: - type: 'null' - - *880 + - *882 sender: *4 required: - action @@ -188965,11 +189204,11 @@ webhooks: type: string required: - from - enterprise: *877 - installation: *878 - organization: *879 - project_column: *922 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + project_column: *924 + repository: *882 sender: *4 required: - action @@ -189049,11 +189288,11 @@ webhooks: type: string enum: - moved - enterprise: *877 - installation: *878 - organization: *879 - project_column: *922 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + project_column: *924 + repository: *882 sender: *4 required: - action @@ -189133,11 +189372,11 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - organization: *879 - project: *923 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + project: *925 + repository: *882 sender: *4 required: - action @@ -189217,14 +189456,14 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - organization: *879 - project: *923 + enterprise: *879 + installation: *880 + organization: *881 + project: *925 repository: anyOf: - type: 'null' - - *880 + - *882 sender: *4 required: - action @@ -189325,11 +189564,11 @@ webhooks: type: string required: - from - enterprise: *877 - installation: *878 - organization: *879 - project: *923 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + project: *925 + repository: *882 sender: *4 required: - action @@ -189408,11 +189647,11 @@ webhooks: type: string enum: - reopened - enterprise: *877 - installation: *878 - organization: *879 - project: *923 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + project: *925 + repository: *882 sender: *4 required: - action @@ -189493,8 +189732,8 @@ webhooks: type: string enum: - closed - installation: *878 - organization: *879 + installation: *880 + organization: *881 projects_v2: *417 sender: *4 required: @@ -189576,8 +189815,8 @@ webhooks: type: string enum: - created - installation: *878 - organization: *879 + installation: *880 + organization: *881 projects_v2: *417 sender: *4 required: @@ -189659,8 +189898,8 @@ webhooks: type: string enum: - deleted - installation: *878 - organization: *879 + installation: *880 + organization: *881 projects_v2: *417 sender: *4 required: @@ -189782,8 +190021,8 @@ webhooks: type: string to: type: string - installation: *878 - organization: *879 + installation: *880 + organization: *881 projects_v2: *417 sender: *4 required: @@ -189867,7 +190106,7 @@ webhooks: type: string enum: - archived - changes: &927 + changes: &929 type: object properties: archived_at: @@ -189883,9 +190122,9 @@ webhooks: - string - 'null' format: date-time - installation: *878 - organization: *879 - projects_v2_item: &924 + installation: *880 + organization: *881 + projects_v2_item: &926 title: Projects v2 Item description: An item belonging to a project type: object @@ -190025,9 +190264,9 @@ webhooks: - 'null' to: type: string - installation: *878 - organization: *879 - projects_v2_item: *924 + installation: *880 + organization: *881 + projects_v2_item: *926 sender: *4 required: - action @@ -190109,9 +190348,9 @@ webhooks: type: string enum: - created - installation: *878 - organization: *879 - projects_v2_item: *924 + installation: *880 + organization: *881 + projects_v2_item: *926 sender: *4 required: - action @@ -190192,9 +190431,9 @@ webhooks: type: string enum: - deleted - installation: *878 - organization: *879 - projects_v2_item: *924 + installation: *880 + organization: *881 + projects_v2_item: *926 sender: *4 required: - action @@ -190299,7 +190538,7 @@ webhooks: oneOf: - type: string - type: integer - - &925 + - &927 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -190323,7 +190562,7 @@ webhooks: required: - id - name - - &926 + - &928 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -190363,8 +190602,8 @@ webhooks: oneOf: - type: string - type: integer - - *925 - - *926 + - *927 + - *928 type: - 'null' - string @@ -190387,9 +190626,9 @@ webhooks: - 'null' required: - body - installation: *878 - organization: *879 - projects_v2_item: *924 + installation: *880 + organization: *881 + projects_v2_item: *926 sender: *4 required: - action @@ -190486,9 +190725,9 @@ webhooks: type: - string - 'null' - installation: *878 - organization: *879 - projects_v2_item: *924 + installation: *880 + organization: *881 + projects_v2_item: *926 sender: *4 required: - action @@ -190571,10 +190810,10 @@ webhooks: type: string enum: - restored - changes: *927 - installation: *878 - organization: *879 - projects_v2_item: *924 + changes: *929 + installation: *880 + organization: *881 + projects_v2_item: *926 sender: *4 required: - action @@ -190656,8 +190895,8 @@ webhooks: type: string enum: - reopened - installation: *878 - organization: *879 + installation: *880 + organization: *881 projects_v2: *417 sender: *4 required: @@ -190739,9 +190978,9 @@ webhooks: type: string enum: - created - installation: *878 - organization: *879 - projects_v2_status_update: *928 + installation: *880 + organization: *881 + projects_v2_status_update: *930 sender: *4 required: - action @@ -190822,9 +191061,9 @@ webhooks: type: string enum: - deleted - installation: *878 - organization: *879 - projects_v2_status_update: *928 + installation: *880 + organization: *881 + projects_v2_status_update: *930 sender: *4 required: - action @@ -190970,9 +191209,9 @@ webhooks: - string - 'null' format: date - installation: *878 - organization: *879 - projects_v2_status_update: *928 + installation: *880 + organization: *881 + projects_v2_status_update: *930 sender: *4 required: - action @@ -191043,10 +191282,10 @@ webhooks: title: public event type: object properties: - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - repository @@ -191123,13 +191362,13 @@ webhooks: type: string enum: - assigned - assignee: *904 - enterprise: *877 - installation: *878 - number: &929 + assignee: *906 + enterprise: *879 + installation: *880 + number: &931 description: The pull request number. type: integer - organization: *879 + organization: *881 pull_request: title: Pull Request type: object @@ -193500,7 +193739,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 sender: *4 required: - action @@ -193582,11 +193821,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 number: type: integer - organization: *879 + organization: *881 pull_request: title: Pull Request type: object @@ -195950,7 +196189,7 @@ webhooks: - draft reason: type: string - repository: *880 + repository: *882 sender: *4 required: - action @@ -196032,11 +196271,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 number: type: integer - organization: *879 + organization: *881 pull_request: title: Pull Request type: object @@ -198400,7 +198639,7 @@ webhooks: - draft reason: type: string - repository: *880 + repository: *882 sender: *4 required: - action @@ -198482,13 +198721,13 @@ webhooks: type: string enum: - closed - enterprise: *877 - installation: *878 - number: *929 - organization: *879 - pull_request: &930 + enterprise: *879 + installation: *880 + number: *931 + organization: *881 + pull_request: &932 allOf: - - *721 + - *723 - type: object properties: allow_auto_merge: @@ -198550,7 +198789,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *880 + repository: *882 sender: *4 required: - action @@ -198631,12 +198870,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *877 - installation: *878 - number: *929 - organization: *879 - pull_request: *930 - repository: *880 + enterprise: *879 + installation: *880 + number: *931 + organization: *881 + pull_request: *932 + repository: *882 sender: *4 required: - action @@ -198716,11 +198955,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *877 + enterprise: *879 milestone: *420 - number: *929 - organization: *879 - pull_request: &931 + number: *931 + organization: *881 + pull_request: &933 title: Pull Request type: object properties: @@ -201069,7 +201308,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 sender: *4 required: - action @@ -201148,11 +201387,11 @@ webhooks: type: string enum: - dequeued - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 number: type: integer - organization: *879 + organization: *881 pull_request: title: Pull Request type: object @@ -203520,7 +203759,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *880 + repository: *882 sender: *4 required: - action @@ -203644,12 +203883,12 @@ webhooks: type: string required: - from - enterprise: *877 - installation: *878 - number: *929 - organization: *879 - pull_request: *930 - repository: *880 + enterprise: *879 + installation: *880 + number: *931 + organization: *881 + pull_request: *932 + repository: *882 sender: *4 required: - action @@ -203729,11 +203968,11 @@ webhooks: type: string enum: - enqueued - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 number: type: integer - organization: *879 + organization: *881 pull_request: title: Pull Request type: object @@ -206086,7 +206325,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 sender: *4 required: - action @@ -206166,11 +206405,11 @@ webhooks: type: string enum: - labeled - enterprise: *877 - installation: *878 - label: *898 - number: *929 - organization: *879 + enterprise: *879 + installation: *880 + label: *900 + number: *931 + organization: *881 pull_request: title: Pull Request type: object @@ -208540,7 +208779,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 sender: *4 required: - action @@ -208621,10 +208860,10 @@ webhooks: type: string enum: - locked - enterprise: *877 - installation: *878 - number: *929 - organization: *879 + enterprise: *879 + installation: *880 + number: *931 + organization: *881 pull_request: title: Pull Request type: object @@ -210992,7 +211231,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 sender: *4 required: - action @@ -211072,12 +211311,12 @@ webhooks: type: string enum: - milestoned - enterprise: *877 + enterprise: *879 milestone: *420 - number: *929 - organization: *879 - pull_request: *931 - repository: *880 + number: *931 + organization: *881 + pull_request: *933 + repository: *882 sender: *4 required: - action @@ -211156,12 +211395,12 @@ webhooks: type: string enum: - opened - enterprise: *877 - installation: *878 - number: *929 - organization: *879 - pull_request: *930 - repository: *880 + enterprise: *879 + installation: *880 + number: *931 + organization: *881 + pull_request: *932 + repository: *882 sender: *4 required: - action @@ -211242,12 +211481,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *877 - installation: *878 - number: *929 - organization: *879 - pull_request: *930 - repository: *880 + enterprise: *879 + installation: *880 + number: *931 + organization: *881 + pull_request: *932 + repository: *882 sender: *4 required: - action @@ -211327,12 +211566,12 @@ webhooks: type: string enum: - reopened - enterprise: *877 - installation: *878 - number: *929 - organization: *879 - pull_request: *930 - repository: *880 + enterprise: *879 + installation: *880 + number: *931 + organization: *881 + pull_request: *932 + repository: *882 sender: *4 required: - action @@ -211707,9 +211946,9 @@ webhooks: - start_side - side - reactions - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 pull_request: type: object properties: @@ -213961,7 +214200,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *880 + repository: *882 sender: *4 required: - action @@ -214041,7 +214280,7 @@ webhooks: type: string enum: - deleted - comment: &933 + comment: &935 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -214334,9 +214573,9 @@ webhooks: - start_side - side - reactions - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 pull_request: type: object properties: @@ -216576,7 +216815,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *880 + repository: *882 sender: *4 required: - action @@ -216656,11 +216895,11 @@ webhooks: type: string enum: - edited - changes: *932 - comment: *933 - enterprise: *877 - installation: *878 - organization: *879 + changes: *934 + comment: *935 + enterprise: *879 + installation: *880 + organization: *881 pull_request: type: object properties: @@ -218903,7 +219142,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *880 + repository: *882 sender: *4 required: - action @@ -218984,9 +219223,9 @@ webhooks: type: string enum: - dismissed - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 pull_request: title: Simple Pull Request type: object @@ -221241,7 +221480,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *880 + repository: *882 review: description: The review that was affected. type: object @@ -221492,9 +221731,9 @@ webhooks: type: string required: - from - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 pull_request: title: Simple Pull Request type: object @@ -223608,8 +223847,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *880 - review: &934 + repository: *882 + review: &936 description: The review that was affected. type: object properties: @@ -223847,12 +224086,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 number: description: The pull request number. type: integer - organization: *879 + organization: *881 pull_request: title: Pull Request type: object @@ -226221,7 +226460,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 requested_reviewer: title: User type: @@ -226307,12 +226546,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 number: description: The pull request number. type: integer - organization: *879 + organization: *881 pull_request: title: Pull Request type: object @@ -228688,7 +228927,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 requested_team: title: Team description: Groups of organization members that gives permissions @@ -228883,12 +229122,12 @@ webhooks: type: string enum: - review_requested - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 number: description: The pull request number. type: integer - organization: *879 + organization: *881 pull_request: title: Pull Request type: object @@ -231259,7 +231498,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 requested_reviewer: title: User type: @@ -231346,12 +231585,12 @@ webhooks: type: string enum: - review_requested - enterprise: *877 - installation: *878 + enterprise: *879 + installation: *880 number: description: The pull request number. type: integer - organization: *879 + organization: *881 pull_request: title: Pull Request type: object @@ -233713,7 +233952,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 requested_team: title: Team description: Groups of organization members that gives permissions @@ -233787,44 +234026,2385 @@ webhooks: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: *4 - required: - - requested_team - - action - - number - - pull_request - - repository - - sender + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: *4 + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app + pull-request-review-submitted: + post: + summary: |- + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)" in the REST API documentation. + + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A review on a pull request was submitted. + operationId: pull-request-review/submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: pull_request_review + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: pull_request_review submitted event + type: object + properties: + action: + type: string + enum: + - submitted + enterprise: *879 + installation: *880 + organization: *881 + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments_url: + type: string + format: uri + commits_url: + type: string + format: uri + created_at: + type: string + diff_url: + type: string + format: uri + draft: + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merge_commit_sha: + type: + - string + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have + for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: *882 + review: *936 + sender: *4 + required: + - action + - review + - pull_request + - repository + - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -233832,23 +236412,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - pull-request-review-submitted: + pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was submitted. - operationId: pull-request-review/submitted + description: A comment thread on a pull request was marked as resolved. + operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -233862,7 +236442,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: pull_request_review + example: pull_request_review_thread schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -233890,16 +236470,16 @@ webhooks: content: application/json: schema: - title: pull_request_review submitted event + title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - - submitted - enterprise: *877 - installation: *878 - organization: *879 + - resolved + enterprise: *879 + installation: *880 + organization: *881 pull_request: title: Simple Pull Request type: object @@ -234061,7 +236641,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -234135,7 +236714,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -234479,28 +237057,6 @@ webhooks: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -234640,28 +237196,6 @@ webhooks: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -234702,13 +237236,6 @@ webhooks: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false visibility: type: string enum: @@ -235128,28 +237655,6 @@ webhooks: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -235289,28 +237794,6 @@ webhooks: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -235351,13 +237834,6 @@ webhooks: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false visibility: type: string enum: @@ -235661,7 +238137,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -236157,15 +238632,330 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *880 - review: *934 + repository: *882 sender: *4 + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment + applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers + to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment + applies. The last line of the range for a multi-line + comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the + comment applies. + type: string + original_line: + description: The line of the blob to which the comment + applies. The last line of the range for a multi-line + comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff + to which the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line + comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the + comment applies. + type: string + position: + description: The line index in the diff to which the comment + applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which + the comment belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review + comment belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for + a multi-line comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line + comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for + a multi-line comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, + can be a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - - review + - thread - pull_request - repository - - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -236173,12 +238963,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - pull-request-review-thread-resolved: + pull-request-review-thread-unresolved: post: summary: |- This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. @@ -236186,8 +238976,9 @@ webhooks: For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment thread on a pull request was marked as resolved. - operationId: pull-request-review-thread/resolved + description: A previously resolved comment thread on a pull request was marked + as unresolved. + operationId: pull-request-review-thread/unresolved externalDocs: url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: @@ -236231,16 +239022,16 @@ webhooks: content: application/json: schema: - title: pull_request_review_thread resolved event + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - resolved - enterprise: *877 - installation: *878 - organization: *879 + - unresolved + enterprise: *879 + installation: *880 + organization: *881 pull_request: title: Simple Pull Request type: object @@ -236508,9 +239299,7 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -237192,17 +239981,13 @@ webhooks: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -238035,7 +240820,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -238147,15 +240931,6 @@ webhooks: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -238347,7 +241122,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -238393,7 +241167,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *880 + repository: *882 sender: *4 thread: type: object @@ -238495,9 +241269,7 @@ webhooks: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment - type: - - integer - - 'null' + type: integer original_position: description: The index of the original line in the diff to which the comment applies. @@ -238667,7 +241439,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -238729,19 +241500,18 @@ webhooks: - repository - organization - app - pull-request-review-thread-unresolved: + pull-request-stacked: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously resolved comment thread on a pull request was marked - as unresolved. - operationId: pull-request-review-thread/unresolved + description: A pull request was added to a stack. + operationId: pull-request/stacked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -238755,7 +241525,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: pull_request_review_thread + example: pull_request schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -238783,18 +241553,19 @@ webhooks: content: application/json: schema: - title: pull_request_review_thread unresolved event + title: pull_request stacked event type: object properties: action: type: string enum: - - unresolved - enterprise: *877 - installation: *878 - organization: *879 + - stacked + enterprise: *879 + installation: *880 + number: *931 + organization: *881 pull_request: - title: Simple Pull Request + title: Pull Request type: object properties: _links: @@ -238891,6 +241662,8 @@ webhooks: - too heated - spam - + additions: + type: integer assignee: title: User type: @@ -238954,6 +241727,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -239027,6 +241801,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -239060,7 +241835,9 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -239368,6 +242145,28 @@ webhooks: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -239507,6 +242306,28 @@ webhooks: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -239547,6 +242368,13 @@ webhooks: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false visibility: type: string enum: @@ -239721,34 +242549,50 @@ webhooks: type: - string - 'null' + changed_files: + type: integer closed_at: type: - string - 'null' + format: date-time + comments: + type: integer comments_url: type: string format: uri + commits: + type: integer commits_url: type: string format: uri created_at: type: string + format: date-time + deletions: + type: integer diff_url: type: string format: uri draft: + description: Indicates whether or not the pull request is a + draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -239962,6 +242806,28 @@ webhooks: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -240101,6 +242967,28 @@ webhooks: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -240141,6 +243029,13 @@ webhooks: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false visibility: type: string enum: @@ -240356,14 +243251,101 @@ webhooks: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull + request. + type: boolean merge_commit_sha: type: - string - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' merged_at: type: - string - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -240444,6 +243426,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -240511,10 +243494,16 @@ webhooks: node_id: type: string number: + description: Number uniquely identifying the pull request within + its repository. type: integer patch_url: type: string format: uri + rebaseable: + type: + - boolean + - 'null' requested_reviewers: type: array items: @@ -240581,6 +243570,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -240692,6 +243682,15 @@ webhooks: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -240801,10 +243800,13 @@ webhooks: review_comment_url: type: string format: uri-template + review_comments: + type: integer review_comments_url: type: string format: uri state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -240813,9 +243815,11 @@ webhooks: type: string format: uri title: + description: The title of the pull request. type: string updated_at: type: string + format: date-time url: type: string format: uri @@ -240883,6 +243887,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -240916,7 +243921,6 @@ webhooks: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -240928,327 +243932,15 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *880 + - draft + repository: *882 sender: *4 - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment - applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers - to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the - comment applies. - type: string - original_line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: integer - original_position: - description: The index of the original line in the diff - to which the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line - comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the - comment applies. - type: string - position: - description: The line index in the diff to which the comment - applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which - the comment belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review - comment belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for - a multi-line comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line - comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for - a multi-line comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, - can be a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: - - string - - 'null' - format: date-time required: - action - - thread + - number - pull_request - repository + - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -241256,7 +243948,7 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization @@ -241327,10 +244019,10 @@ webhooks: type: string before: type: string - enterprise: *877 - installation: *878 - number: *929 - organization: *879 + enterprise: *879 + installation: *880 + number: *931 + organization: *881 pull_request: title: Pull Request type: object @@ -243687,7 +246379,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 sender: *4 required: - action @@ -243769,11 +246461,11 @@ webhooks: type: string enum: - unassigned - assignee: *935 - enterprise: *877 - installation: *878 - number: *929 - organization: *879 + assignee: *937 + enterprise: *879 + installation: *880 + number: *931 + organization: *881 pull_request: title: Pull Request type: object @@ -246145,7 +248837,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 sender: *4 required: - action @@ -246224,11 +248916,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *877 - installation: *878 - label: *898 - number: *929 - organization: *879 + enterprise: *879 + installation: *880 + label: *900 + number: *931 + organization: *881 pull_request: title: Pull Request type: object @@ -248589,7 +251281,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 sender: *4 required: - action @@ -248670,10 +251362,10 @@ webhooks: type: string enum: - unlocked - enterprise: *877 - installation: *878 - number: *929 - organization: *879 + enterprise: *879 + installation: *880 + number: *931 + organization: *881 pull_request: title: Pull Request type: object @@ -251024,7 +253716,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *880 + repository: *882 sender: *4 required: - action @@ -251227,7 +253919,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *877 + enterprise: *879 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -251322,8 +254014,8 @@ webhooks: - url - author - committer - installation: *878 - organization: *879 + installation: *880 + organization: *881 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -251922,9 +254614,9 @@ webhooks: type: string enum: - published - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 registry_package: type: object properties: @@ -252401,7 +255093,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *918 + items: *920 summary: type: string tag_name: @@ -252457,7 +255149,7 @@ webhooks: - owner - package_version - registry - repository: *880 + repository: *882 sender: *4 required: - action @@ -252535,9 +255227,9 @@ webhooks: type: string enum: - updated - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 registry_package: type: object properties: @@ -252849,7 +255541,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *918 + items: *920 summary: type: string tag_name: @@ -252899,7 +255591,7 @@ webhooks: - owner - package_version - registry - repository: *880 + repository: *882 sender: *4 required: - action @@ -252976,10 +255668,10 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - organization: *879 - release: &936 + enterprise: *879 + installation: *880 + organization: *881 + release: &938 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -253310,7 +256002,7 @@ webhooks: - updated_at - zipball_url - body - repository: *880 + repository: *882 sender: *4 required: - action @@ -253387,11 +256079,11 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - organization: *879 - release: *936 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + release: *938 + repository: *882 sender: *4 required: - action @@ -253508,11 +256200,11 @@ webhooks: type: boolean required: - to - enterprise: *877 - installation: *878 - organization: *879 - release: *936 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + release: *938 + repository: *882 sender: *4 required: - action @@ -253590,9 +256282,9 @@ webhooks: type: string enum: - prereleased - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) @@ -253928,7 +256620,7 @@ webhooks: - string - 'null' format: uri - repository: *880 + repository: *882 sender: *4 required: - action @@ -254004,10 +256696,10 @@ webhooks: type: string enum: - published - enterprise: *877 - installation: *878 - organization: *879 - release: &937 + enterprise: *879 + installation: *880 + organization: *881 + release: &939 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -254340,7 +257032,7 @@ webhooks: - string - 'null' format: uri - repository: *880 + repository: *882 sender: *4 required: - action @@ -254416,11 +257108,11 @@ webhooks: type: string enum: - released - enterprise: *877 - installation: *878 - organization: *879 - release: *936 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + release: *938 + repository: *882 sender: *4 required: - action @@ -254496,11 +257188,11 @@ webhooks: type: string enum: - unpublished - enterprise: *877 - installation: *878 - organization: *879 - release: *937 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + release: *939 + repository: *882 sender: *4 required: - action @@ -254576,11 +257268,11 @@ webhooks: type: string enum: - published - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - repository_advisory: *775 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + repository_advisory: *777 sender: *4 required: - action @@ -254656,11 +257348,11 @@ webhooks: type: string enum: - reported - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - repository_advisory: *775 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + repository_advisory: *777 sender: *4 required: - action @@ -254736,10 +257428,10 @@ webhooks: type: string enum: - archived - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -254816,10 +257508,10 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -254897,10 +257589,10 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -254985,10 +257677,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -255103,10 +257795,10 @@ webhooks: - 'null' items: type: string - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -255178,10 +257870,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 status: type: string @@ -255262,10 +257954,10 @@ webhooks: type: string enum: - privatized - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -255342,10 +258034,10 @@ webhooks: type: string enum: - publicized - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -255439,10 +258131,10 @@ webhooks: - name required: - repository - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -255522,10 +258214,10 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 repository_ruleset: *190 sender: *4 required: @@ -255604,10 +258296,10 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 repository_ruleset: *190 sender: *4 required: @@ -255686,10 +258378,10 @@ webhooks: type: string enum: - edited - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 repository_ruleset: *190 changes: type: object @@ -255751,16 +258443,16 @@ webhooks: properties: added: type: array - items: *742 + items: *744 deleted: type: array - items: *742 + items: *744 updated: type: array items: type: object properties: - rule: *742 + rule: *744 changes: type: object properties: @@ -255997,10 +258689,10 @@ webhooks: - from required: - owner - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -256078,10 +258770,10 @@ webhooks: type: string enum: - unarchived - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -256159,7 +258851,7 @@ webhooks: type: string enum: - create - alert: &938 + alert: &940 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -256284,10 +258976,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -256497,10 +259189,10 @@ webhooks: type: string enum: - dismissed - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -256578,11 +259270,11 @@ webhooks: type: string enum: - reopen - alert: *938 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + alert: *940 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -256784,10 +259476,10 @@ webhooks: enum: - fixed - open - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -256865,7 +259557,7 @@ webhooks: type: string enum: - assigned - alert: &939 + alert: &942 type: object properties: number: *130 @@ -257004,11 +259696,12 @@ webhooks: anyOf: - type: 'null' - *4 + metadata: *941 assignee: *4 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -257086,11 +259779,11 @@ webhooks: type: string enum: - created - alert: *939 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + alert: *942 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -257171,11 +259864,11 @@ webhooks: type: string enum: - created - alert: *939 - installation: *878 - location: *940 - organization: *879 - repository: *880 + alert: *942 + installation: *880 + location: *943 + organization: *881 + repository: *882 sender: *4 required: - location @@ -257353,6 +260046,168 @@ webhooks: - repository - organization - app + secret-scanning-alert-metadata-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: Metadata was created for a secret scanning alert. + operationId: secret-scanning-alert/metadata-created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: secret_scanning_alert + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + 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: secret_scanning_alert metadata created event + type: object + properties: + action: + type: string + enum: + - metadata_created + alert: *942 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-metadata-removed: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: Metadata was removed from a secret scanning alert. + operationId: secret-scanning-alert/metadata-removed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: secret_scanning_alert + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + 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: secret_scanning_alert metadata removed event + type: object + properties: + action: + type: string + enum: + - metadata_removed + alert: *942 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-publicly-leaked: post: summary: |- @@ -257413,11 +260268,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *939 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + alert: *942 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -257495,11 +260350,11 @@ webhooks: type: string enum: - reopened - alert: *939 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + alert: *942 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -257577,11 +260432,11 @@ webhooks: type: string enum: - resolved - alert: *939 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + alert: *942 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -257659,12 +260514,12 @@ webhooks: type: string enum: - unassigned - alert: *939 + alert: *942 assignee: *4 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -257742,11 +260597,11 @@ webhooks: type: string enum: - validated - alert: *939 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + alert: *942 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -257876,10 +260731,10 @@ webhooks: - organization - enterprise - - repository: *880 - enterprise: *877 - installation: *878 - organization: *879 + repository: *882 + enterprise: *879 + installation: *880 + organization: *881 sender: *4 required: - action @@ -257957,11 +260812,11 @@ webhooks: type: string enum: - published - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - security_advisory: &941 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + security_advisory: &944 description: The details of the security advisory, including summary, description, and severity. type: object @@ -258147,11 +261002,11 @@ webhooks: type: string enum: - updated - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 - security_advisory: *941 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 + security_advisory: *944 sender: *4 required: - action @@ -258224,10 +261079,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -258414,10 +261269,10 @@ webhooks: type: object properties: security_and_analysis: *431 - enterprise: *877 - installation: *878 - organization: *879 - repository: *477 + enterprise: *879 + installation: *880 + organization: *881 + repository: *479 sender: *4 required: - changes @@ -258495,12 +261350,12 @@ webhooks: type: string enum: - cancelled - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 - sponsorship: &942 + sponsorship: &945 type: object properties: created_at: @@ -258805,12 +261660,12 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 - sponsorship: *942 + sponsorship: *945 required: - action - sponsorship @@ -258898,12 +261753,12 @@ webhooks: type: string required: - from - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 - sponsorship: *942 + sponsorship: *945 required: - action - changes @@ -258980,17 +261835,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &943 + effective_date: &946 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 - sponsorship: *942 + sponsorship: *945 required: - action - sponsorship @@ -259064,7 +261919,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &944 + changes: &947 type: object properties: tier: @@ -259108,13 +261963,13 @@ webhooks: - from required: - tier - effective_date: *943 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + effective_date: *946 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 - sponsorship: *942 + sponsorship: *945 required: - action - changes @@ -259191,13 +262046,13 @@ webhooks: type: string enum: - tier_changed - changes: *944 - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + changes: *947 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 - sponsorship: *942 + sponsorship: *945 required: - action - changes @@ -259271,10 +262126,10 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -259358,10 +262213,10 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -259795,15 +262650,15 @@ webhooks: type: - string - 'null' - enterprise: *877 + enterprise: *879 id: description: The unique identifier of the status. type: integer - installation: *878 + installation: *880 name: type: string - organization: *879 - repository: *880 + organization: *881 + repository: *882 sender: *4 sha: description: The Commit SHA. @@ -259919,9 +262774,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *221 - installation: *878 - organization: *879 - repository: *880 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -260010,9 +262865,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *221 - installation: *878 - organization: *879 - repository: *880 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -260101,9 +262956,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *221 - installation: *878 - organization: *879 - repository: *880 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -260192,9 +263047,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *221 - installation: *878 - organization: *879 - repository: *880 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -260270,12 +263125,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 - team: &945 + team: &948 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -260505,9 +263360,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 repository: title: Repository description: A git repository @@ -260977,7 +263832,7 @@ webhooks: - topics - visibility sender: *4 - team: *945 + team: *948 required: - action - team @@ -261053,9 +263908,9 @@ webhooks: type: string enum: - created - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 repository: title: Repository description: A git repository @@ -261525,7 +264380,7 @@ webhooks: - topics - visibility sender: *4 - team: *945 + team: *948 required: - action - team @@ -261602,9 +264457,9 @@ webhooks: type: string enum: - deleted - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 repository: title: Repository description: A git repository @@ -262074,7 +264929,7 @@ webhooks: - topics - visibility sender: *4 - team: *945 + team: *948 required: - action - team @@ -262218,9 +265073,9 @@ webhooks: - from required: - permissions - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 repository: title: Repository description: A git repository @@ -262690,7 +265545,7 @@ webhooks: - topics - visibility sender: *4 - team: *945 + team: *948 required: - action - changes @@ -262768,9 +265623,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *877 - installation: *878 - organization: *879 + enterprise: *879 + installation: *880 + organization: *881 repository: title: Repository description: A git repository @@ -263240,7 +266095,7 @@ webhooks: - topics - visibility sender: *4 - team: *945 + team: *948 required: - action - team @@ -263316,10 +266171,10 @@ webhooks: type: string enum: - started - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 required: - action @@ -263392,17 +266247,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *877 + enterprise: *879 inputs: type: - object - 'null' additionalProperties: true - installation: *878 - organization: *879 + installation: *880 + organization: *881 ref: type: string - repository: *880 + repository: *882 sender: *4 workflow: type: string @@ -263484,10 +266339,10 @@ webhooks: type: string enum: - completed - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 workflow_job: allOf: @@ -263743,7 +266598,7 @@ webhooks: type: string required: - conclusion - deployment: *613 + deployment: *615 required: - action - repository @@ -263822,10 +266677,10 @@ webhooks: type: string enum: - in_progress - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 workflow_job: allOf: @@ -264107,7 +266962,7 @@ webhooks: required: - status - steps - deployment: *613 + deployment: *615 required: - action - repository @@ -264186,10 +267041,10 @@ webhooks: type: string enum: - queued - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 workflow_job: type: object @@ -264335,7 +267190,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *613 + deployment: *615 required: - action - repository @@ -264414,10 +267269,10 @@ webhooks: type: string enum: - waiting - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + installation: *880 + organization: *881 + repository: *882 sender: *4 workflow_job: type: object @@ -264564,7 +267419,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *613 + deployment: *615 required: - action - repository @@ -264644,12 +267499,12 @@ webhooks: type: string enum: - completed - enterprise: *877 - installation: *878 - organization: *879 - repository: *880 + enterprise: *879 + i{"code":"deadline_exceeded","msg":"operation timed out"}