diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 6cb7ffb00d..c6d73ff3d3 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -36153,6 +36153,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": { @@ -72239,6 +72245,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": { @@ -72307,7 +72319,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -72432,7 +72444,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -105911,6 +105923,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.", @@ -109367,11 +109472,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" }, @@ -109438,7 +109543,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-created" } } } @@ -109449,7 +109554,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -109460,11 +109564,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" }, @@ -109531,7 +109635,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-removed" } } } @@ -109542,7 +109646,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -109553,11 +109656,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" }, @@ -109624,7 +109727,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -109646,11 +109749,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" }, @@ -109717,7 +109820,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -109739,11 +109842,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" }, @@ -109810,7 +109913,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -109832,13 +109935,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": [ { @@ -109860,7 +109963,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_scan", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -109903,7 +110006,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -109916,7 +110019,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_scan", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -109925,13 +110028,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": [ { @@ -109953,7 +110056,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -109996,7 +110099,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -110009,20 +110112,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": [ { @@ -110044,7 +110149,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_scan", "schema": { "type": "string" } @@ -110087,7 +110192,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -110100,18 +110205,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" }, @@ -110178,7 +110285,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -110198,12 +110305,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": [ { @@ -110225,7 +110333,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_and_analysis", + "example": "security_advisory", "schema": { "type": "string" } @@ -110268,7 +110376,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -110281,22 +110389,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": [ { @@ -110318,7 +110424,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_advisory", "schema": { "type": "string" } @@ -110361,7 +110467,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -110374,20 +110480,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": [ { @@ -110409,7 +110514,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_and_analysis", "schema": { "type": "string" } @@ -110452,7 +110557,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -110465,18 +110570,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" }, @@ -110543,7 +110650,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -110563,11 +110670,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" }, @@ -110634,7 +110741,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -110654,11 +110761,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" }, @@ -110725,7 +110832,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -110745,11 +110852,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" }, @@ -110816,7 +110923,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -110836,13 +110943,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": [ { @@ -110864,7 +110971,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -110907,7 +111014,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -110920,22 +111027,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": [ { @@ -110957,7 +111062,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111000,7 +111105,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -111013,21 +111118,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": [ { @@ -111049,7 +111153,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "status", + "example": "star", "schema": { "type": "string" } @@ -111092,7 +111196,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -111105,7 +111209,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111114,13 +111218,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": [ { @@ -111142,7 +111246,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "star", "schema": { "type": "string" } @@ -111185,7 +111289,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -111198,7 +111302,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111207,13 +111311,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": [ { @@ -111235,7 +111338,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "status", "schema": { "type": "string" } @@ -111278,7 +111381,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" } } } @@ -111291,7 +111394,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "status", "supported-webhook-types": [ "repository", "organization", @@ -111300,11 +111403,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" }, @@ -111371,7 +111474,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -111393,11 +111496,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" }, @@ -111464,7 +111567,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -111486,12 +111589,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": [ { @@ -111513,7 +111617,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team_add", + "example": "sub_issues", "schema": { "type": "string" } @@ -111556,7 +111660,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -111569,7 +111673,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "sub-issues", "supported-webhook-types": [ "repository", "organization", @@ -111578,13 +111682,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": [ { @@ -111606,7 +111710,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "sub_issues", "schema": { "type": "string" } @@ -111649,7 +111753,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -111662,22 +111766,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": [ { @@ -111699,7 +111802,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "team_add", "schema": { "type": "string" } @@ -111742,7 +111845,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -111755,20 +111858,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" }, @@ -111835,7 +111938,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -111857,11 +111960,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" }, @@ -111928,7 +112031,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -111950,11 +112053,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" }, @@ -112021,7 +112124,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-deleted" } } } @@ -112043,13 +112146,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": [ { @@ -112071,7 +112174,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "watch", + "example": "team", "schema": { "type": "string" } @@ -112114,7 +112217,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-edited" } } } @@ -112127,21 +112230,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": [ { @@ -112163,7 +112267,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_dispatch", + "example": "team", "schema": { "type": "string" } @@ -112206,7 +112310,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" } } } @@ -112219,20 +112323,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": [ { @@ -112254,7 +112360,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "watch", "schema": { "type": "string" } @@ -112297,7 +112403,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-watch-started" } } } @@ -112310,9 +112416,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "watch", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -112320,13 +112425,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": [ { @@ -112348,7 +112452,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" } @@ -131702,6 +131991,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." @@ -148949,6 +149241,178 @@ } } }, + "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": { + "$ref": "#/components/schemas/nullable-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", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "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.", + "nullable": true + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", + "nullable": true + }, + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-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": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true + }, + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true + }, + "closure_request_reviewer": { + "$ref": "#/components/schemas/nullable-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": "string", @@ -165267,6 +165731,9 @@ }, "closure_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" + }, + "metadata": { + "$ref": "#/components/schemas/secret-scanning-alert-metadata" } } }, @@ -261233,8 +261700,2881 @@ "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", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "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": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "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": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "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", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, "url": { @@ -261676,23 +265016,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" @@ -261880,23 +265203,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" }, @@ -261952,11 +265258,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": [ @@ -262475,23 +265776,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" @@ -262679,23 +265963,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" }, @@ -262751,11 +266018,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": [ @@ -263124,8 +266386,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -263763,29 +267024,405 @@ "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": "integer", + "nullable": true + }, + "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", + "nullable": true + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "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", + "nullable": true, + "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": { @@ -264149,8 +267786,7 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string", - "nullable": true + "type": "string" }, "enabled_by": { "title": "User", @@ -265026,8 +268662,7 @@ "type": "object", "properties": { "label": { - "type": "string", - "nullable": true + "type": "string" }, "ref": { "type": "string" @@ -265036,7 +268671,6 @@ "title": "Repository", "description": "A git repository", "type": "object", - "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -266098,8 +269732,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -266241,16 +269874,7 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "id" ] } ] @@ -266497,8 +270121,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -266678,8 +270301,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", - "nullable": true + "type": "integer" }, "original_position": { "description": "The index of the original line in the diff to which the comment applies.", @@ -266879,8 +270501,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -266948,14 +270569,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": { @@ -266964,11 +270585,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": { @@ -267101,6 +270725,9 @@ null ] }, + "additions": { + "type": "integer" + }, "assignee": { "title": "User", "type": "object", @@ -267180,7 +270807,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -267277,7 +270905,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -267319,7 +270948,8 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": "string", + "nullable": true }, "enabled_by": { "title": "User", @@ -267718,6 +271348,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" @@ -267905,6 +271552,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" }, @@ -267960,6 +271624,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": [ @@ -268169,33 +271838,49 @@ "type": "string", "nullable": true }, + "changed_files": { + "type": "integer" + }, "closed_at": { "type": "string", - "nullable": true + "nullable": true, + "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", + "nullable": true }, "ref": { "type": "string" @@ -268204,6 +271889,7 @@ "title": "Repository", "description": "A git repository", "type": "object", + "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -268476,6 +272162,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" @@ -268663,6 +272366,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" }, @@ -268718,6 +272438,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": [ @@ -268981,13 +272706,125 @@ "locked": { "type": "boolean" }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, "merge_commit_sha": { "type": "string", "nullable": true }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, "merged_at": { "type": "string", - "nullable": true + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] }, "milestone": { "title": "Milestone", @@ -269086,7 +272923,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -269176,12 +273014,17 @@ "type": "string" }, "number": { + "description": "Number uniquely identifying the pull request within its repository.", "type": "integer" }, "patch_url": { "type": "string", "format": "uri" }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, "requested_reviewers": { "type": "array", "items": { @@ -269265,7 +273108,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -269407,7 +273251,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -269549,11 +273402,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", @@ -269565,10 +273422,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", @@ -269654,7 +273513,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -269696,7 +273556,6 @@ "requested_teams", "labels", "milestone", - "draft", "commits_url", "review_comments_url", "review_comment_url", @@ -269707,7 +273566,8 @@ "_links", "author_association", "auto_merge", - "active_lock_reason" + "active_lock_reason", + "draft" ] }, "repository": { @@ -269715,391 +273575,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", - "nullable": true - }, - "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", - "nullable": true - }, - "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", - "nullable": true - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": "integer", - "nullable": true - }, - "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", - "nullable": true - }, - "start_side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": "string", - "nullable": true, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "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", - "nullable": true, - "format": "date-time" } }, "required": [ "action", - "thread", + "number", "pull_request", - "repository" + "repository", + "sender" ] }, "webhook-pull-request-synchronize": { @@ -286331,18 +289814,257 @@ "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", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "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" @@ -286363,186 +290085,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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": "string", - "nullable": true, - "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" @@ -286563,32 +290120,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" }, @@ -286600,19 +290153,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": { @@ -286640,25 +290207,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" }, @@ -286670,23 +290237,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": { @@ -324278,7 +327831,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": { @@ -324325,6 +327884,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -332489,6 +336054,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/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 03f121358f..57dc42671c 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -26654,6 +26654,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 @@ -52930,6 +52932,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 @@ -52978,7 +52982,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" @@ -53063,7 +53067,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" @@ -77065,6 +77069,72 @@ x-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: |- @@ -79492,7 +79562,7 @@ x-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. @@ -79500,8 +79570,8 @@ x-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: @@ -79545,20 +79615,19 @@ x-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. @@ -79566,8 +79635,8 @@ x-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: @@ -79611,20 +79680,19 @@ x-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. @@ -79632,8 +79700,8 @@ x-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: @@ -79677,7 +79745,7 @@ x-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 @@ -79690,7 +79758,7 @@ x-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. @@ -79698,8 +79766,8 @@ x-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: @@ -79743,7 +79811,7 @@ x-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 @@ -79756,7 +79824,7 @@ x-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. @@ -79764,8 +79832,8 @@ x-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: @@ -79809,7 +79877,7 @@ x-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 @@ -79822,19 +79890,18 @@ x-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 @@ -79848,7 +79915,7 @@ x-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 @@ -79876,7 +79943,7 @@ x-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 @@ -79884,21 +79951,23 @@ x-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 @@ -79912,7 +79981,7 @@ x-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 @@ -79940,7 +80009,7 @@ x-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 @@ -79948,19 +80017,24 @@ x-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 @@ -79974,7 +80048,7 @@ x-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 @@ -80002,7 +80076,7 @@ x-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 @@ -80010,17 +80084,19 @@ x-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: @@ -80064,7 +80140,7 @@ x-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 @@ -80075,15 +80151,16 @@ x-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 @@ -80097,7 +80174,7 @@ x-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 @@ -80125,7 +80202,7 @@ x-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 @@ -80133,24 +80210,19 @@ x-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 @@ -80164,7 +80236,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: sponsorship + example: security_advisory schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80192,7 +80264,7 @@ x-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 @@ -80200,20 +80272,18 @@ x-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 @@ -80227,7 +80297,7 @@ x-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 @@ -80255,7 +80325,7 @@ x-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 @@ -80263,19 +80333,22 @@ x-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: @@ -80319,7 +80392,7 @@ x-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 @@ -80330,17 +80403,15 @@ x-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: @@ -80384,7 +80455,7 @@ x-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 @@ -80395,15 +80466,144 @@ x-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: + - 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: sponsorship + 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-sponsorship-edited" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + 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 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: + - 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: sponsorship + 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-sponsorship-pending-cancellation" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + sponsorship-pending-tier-change: + 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 externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -97017,6 +97217,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 @@ -110119,6 +110321,144 @@ components: nullable: true closure_request_reviewer: "$ref": "#/components/schemas/nullable-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: + "$ref": "#/components/schemas/nullable-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 + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + "$ref": "#/components/schemas/nullable-simple-user" + resolution_comment: + type: string + description: An optional comment to resolve an alert. + nullable: true + 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 + description: The provider of the secret that was detected. + nullable: true + provider_slug: + type: string + 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. + nullable: true + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the detected secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple repositories + under the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert is base64 + encoded + nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-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: + "$ref": "#/components/schemas/nullable-simple-user" + closure_request_comment: + type: string + description: An optional comment from the closure request author. + nullable: true + closure_request_reviewer_comment: + type: string + description: An optional comment from the closure request reviewer. + nullable: true + closure_request_reviewer: + "$ref": "#/components/schemas/nullable-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. @@ -122633,6 +122973,8 @@ components: nullable: true closure_request_reviewer: "$ref": "#/components/schemas/nullable-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. @@ -194530,53 +194872,2262 @@ 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + 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 + nullable: true + properties: + commit_message: + description: Commit message for the merge commit. + type: string + nullable: true + commit_title: + description: Title for the merge commit message. + type: string + nullable: true + enabled_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - 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 + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merge_commit_sha: + type: string + nullable: true + merged_at: + type: string + nullable: true + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - 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: @@ -194741,7 +197292,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -194813,7 +197363,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -195143,28 +197692,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 @@ -195297,28 +197824,6 @@ components: nullable: true 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: @@ -195359,12 +197864,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: @@ -195769,28 +198268,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 @@ -195923,28 +198400,6 @@ components: nullable: true 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: @@ -195985,12 +198440,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: @@ -196285,7 +198734,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -196768,24 +199216,321 @@ 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: integer + nullable: true + 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 + nullable: true + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - 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 + nullable: true + 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: @@ -197053,7 +199798,6 @@ components: commit_title: description: Title for the merge commit message. type: string - nullable: true enabled_by: title: User type: object @@ -197714,14 +200458,12 @@ components: properties: label: type: string - nullable: true ref: type: string repo: title: Repository description: A git repository type: object - nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -198525,7 +201267,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198633,15 +201374,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -198826,7 +201558,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198972,7 +201703,6 @@ components: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer - nullable: true original_position: description: The index of the original line in the diff to which the comment applies. @@ -199132,7 +201862,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -199181,22 +201910,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: @@ -199292,6 +202023,8 @@ components: - too heated - spam - null + additions: + type: integer assignee: title: User type: object @@ -199353,6 +202086,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -199424,6 +202158,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -199456,6 +202191,7 @@ components: commit_title: description: Title for the merge commit message. type: string + nullable: true enabled_by: title: User type: object @@ -199752,6 +202488,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 @@ -199884,6 +202642,28 @@ components: nullable: true 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: @@ -199924,6 +202704,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: @@ -200095,33 +202881,46 @@ components: body: type: string nullable: true + changed_files: + type: integer closed_at: type: string nullable: true + 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 + nullable: true ref: type: string repo: title: Repository description: A git repository type: object + nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -200326,6 +203125,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 @@ -200458,6 +203279,28 @@ components: nullable: true 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: @@ -200498,6 +203341,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: @@ -200710,12 +203559,94 @@ components: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean merge_commit_sha: type: string nullable: true + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true merged_at: type: string nullable: true + format: date-time + merged_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -200792,6 +203723,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -200857,10 +203789,15 @@ 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 + nullable: true requested_reviewers: type: array items: @@ -200925,6 +203862,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -201032,6 +203970,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -201136,10 +204083,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 @@ -201148,9 +204098,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 @@ -201216,6 +204168,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -201249,7 +204202,6 @@ components: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -201261,313 +204213,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 - nullable: true - 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 - nullable: true - 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 - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: integer - nullable: true - 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 - nullable: true - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: string - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - 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 - nullable: true - format: date-time required: - action - - thread + - number - pull_request - repository + - sender webhook-pull-request-synchronize: title: pull_request synchronize event type: object @@ -214047,6 +216703,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 @@ -245370,6 +248074,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 @@ -245413,6 +248120,9 @@ components: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -252546,6 +255256,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/api.github.com/api.github.com.2026-03-10.json b/descriptions/api.github.com/api.github.com.2026-03-10.json index c16d08a5c3..038b82b709 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions/api.github.com/api.github.com.2026-03-10.json @@ -36115,6 +36115,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": { @@ -72156,6 +72162,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": { @@ -72224,7 +72236,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -72349,7 +72361,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -105796,6 +105808,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.", @@ -109252,11 +109357,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" }, @@ -109323,7 +109428,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-created" } } } @@ -109334,7 +109439,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -109345,11 +109449,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" }, @@ -109416,7 +109520,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-removed" } } } @@ -109427,7 +109531,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -109438,11 +109541,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" }, @@ -109509,7 +109612,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -109531,11 +109634,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" }, @@ -109602,7 +109705,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -109624,11 +109727,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" }, @@ -109695,7 +109798,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -109717,13 +109820,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": [ { @@ -109745,7 +109848,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_scan", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -109788,7 +109891,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -109801,7 +109904,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_scan", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -109810,13 +109913,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": [ { @@ -109838,7 +109941,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -109881,7 +109984,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -109894,20 +109997,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": [ { @@ -109929,7 +110034,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_scan", "schema": { "type": "string" } @@ -109972,7 +110077,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -109985,18 +110090,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" }, @@ -110063,7 +110170,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -110083,12 +110190,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": [ { @@ -110110,7 +110218,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_and_analysis", + "example": "security_advisory", "schema": { "type": "string" } @@ -110153,7 +110261,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -110166,22 +110274,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": [ { @@ -110203,7 +110309,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_advisory", "schema": { "type": "string" } @@ -110246,7 +110352,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -110259,20 +110365,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": [ { @@ -110294,7 +110399,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_and_analysis", "schema": { "type": "string" } @@ -110337,7 +110442,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -110350,18 +110455,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" }, @@ -110428,7 +110535,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -110448,11 +110555,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" }, @@ -110519,7 +110626,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -110539,11 +110646,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" }, @@ -110610,7 +110717,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -110630,11 +110737,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" }, @@ -110701,7 +110808,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -110721,13 +110828,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": [ { @@ -110749,7 +110856,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -110792,7 +110899,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -110805,22 +110912,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": [ { @@ -110842,7 +110947,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -110885,7 +110990,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -110898,21 +111003,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": [ { @@ -110934,7 +111038,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "status", + "example": "star", "schema": { "type": "string" } @@ -110977,7 +111081,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -110990,7 +111094,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -110999,13 +111103,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": [ { @@ -111027,7 +111131,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "star", "schema": { "type": "string" } @@ -111070,7 +111174,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -111083,7 +111187,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111092,13 +111196,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": [ { @@ -111120,7 +111223,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "status", "schema": { "type": "string" } @@ -111163,7 +111266,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" } } } @@ -111176,7 +111279,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "status", "supported-webhook-types": [ "repository", "organization", @@ -111185,11 +111288,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" }, @@ -111256,7 +111359,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -111278,11 +111381,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" }, @@ -111349,7 +111452,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -111371,12 +111474,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": [ { @@ -111398,7 +111502,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team_add", + "example": "sub_issues", "schema": { "type": "string" } @@ -111441,7 +111545,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -111454,7 +111558,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "sub-issues", "supported-webhook-types": [ "repository", "organization", @@ -111463,13 +111567,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": [ { @@ -111491,7 +111595,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "sub_issues", "schema": { "type": "string" } @@ -111534,7 +111638,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -111547,22 +111651,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": [ { @@ -111584,7 +111687,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "team_add", "schema": { "type": "string" } @@ -111627,7 +111730,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -111640,20 +111743,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" }, @@ -111720,7 +111823,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -111742,11 +111845,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" }, @@ -111813,7 +111916,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -111835,11 +111938,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" }, @@ -111906,7 +112009,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-deleted" } } } @@ -111928,13 +112031,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": [ { @@ -111956,7 +112059,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "watch", + "example": "team", "schema": { "type": "string" } @@ -111999,7 +112102,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-edited" } } } @@ -112012,21 +112115,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": [ { @@ -112048,7 +112152,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_dispatch", + "example": "team", "schema": { "type": "string" } @@ -112091,7 +112195,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" } } } @@ -112104,20 +112208,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": [ { @@ -112139,7 +112245,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "watch", "schema": { "type": "string" } @@ -112182,7 +112288,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-watch-started" } } } @@ -112195,9 +112301,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "watch", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -112205,13 +112310,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": [ { @@ -112233,7 +112337,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" } @@ -131168,6 +131457,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." @@ -148364,6 +148656,178 @@ } } }, + "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": { + "$ref": "#/components/schemas/nullable-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", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "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.", + "nullable": true + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", + "nullable": true + }, + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-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": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true + }, + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true + }, + "closure_request_reviewer": { + "$ref": "#/components/schemas/nullable-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": "string", @@ -164858,6 +165322,9 @@ }, "closure_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" + }, + "metadata": { + "$ref": "#/components/schemas/secret-scanning-alert-metadata" } } }, @@ -260597,8 +261064,2866 @@ "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", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "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": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "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": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "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", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merged_at": { + "type": "string", + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, "url": { @@ -261040,23 +264365,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" @@ -261244,23 +264552,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" }, @@ -261834,23 +265125,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" @@ -262038,23 +265312,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" }, @@ -262474,8 +265731,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -263112,29 +266368,405 @@ "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": "integer", + "nullable": true + }, + "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", + "nullable": true + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "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", + "nullable": true, + "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": { @@ -263498,8 +267130,7 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string", - "nullable": true + "type": "string" }, "enabled_by": { "title": "User", @@ -264375,8 +268006,7 @@ "type": "object", "properties": { "label": { - "type": "string", - "nullable": true + "type": "string" }, "ref": { "type": "string" @@ -264385,7 +268015,6 @@ "title": "Repository", "description": "A git repository", "type": "object", - "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -265443,8 +269072,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -265586,16 +269214,7 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "id" ] } ] @@ -265842,8 +269461,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -266022,8 +269640,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", - "nullable": true + "type": "integer" }, "original_position": { "description": "The index of the original line in the diff to which the comment applies.", @@ -266223,8 +269840,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -266292,14 +269908,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": { @@ -266308,11 +269924,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": { @@ -266445,6 +270064,9 @@ null ] }, + "additions": { + "type": "integer" + }, "assignee": { "title": "User", "type": "object", @@ -266524,7 +270146,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -266621,7 +270244,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -266663,7 +270287,8 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": "string", + "nullable": true }, "enabled_by": { "title": "User", @@ -267062,6 +270687,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" @@ -267249,6 +270891,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" }, @@ -267513,33 +271172,49 @@ "type": "string", "nullable": true }, + "changed_files": { + "type": "integer" + }, "closed_at": { "type": "string", - "nullable": true + "nullable": true, + "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", + "nullable": true }, "ref": { "type": "string" @@ -267548,6 +271223,7 @@ "title": "Repository", "description": "A git repository", "type": "object", + "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -267820,6 +271496,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" @@ -268007,6 +271700,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" }, @@ -268325,9 +272035,121 @@ "locked": { "type": "boolean" }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, "merged_at": { "type": "string", - "nullable": true + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] }, "milestone": { "title": "Milestone", @@ -268426,7 +272248,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -268516,12 +272339,17 @@ "type": "string" }, "number": { + "description": "Number uniquely identifying the pull request within its repository.", "type": "integer" }, "patch_url": { "type": "string", "format": "uri" }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, "requested_reviewers": { "type": "array", "items": { @@ -268605,7 +272433,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -268747,7 +272576,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -268889,11 +272727,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", @@ -268905,10 +272747,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", @@ -268994,7 +272838,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -269035,7 +272880,6 @@ "requested_teams", "labels", "milestone", - "draft", "commits_url", "review_comments_url", "review_comment_url", @@ -269046,7 +272890,8 @@ "_links", "author_association", "auto_merge", - "active_lock_reason" + "active_lock_reason", + "draft" ] }, "repository": { @@ -269054,391 +272899,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", - "nullable": true - }, - "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", - "nullable": true - }, - "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", - "nullable": true - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": "integer", - "nullable": true - }, - "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", - "nullable": true - }, - "start_side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": "string", - "nullable": true, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "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", - "nullable": true, - "format": "date-time" } }, "required": [ "action", - "thread", + "number", "pull_request", - "repository" + "repository", + "sender" ] }, "webhook-pull-request-synchronize": { @@ -285610,18 +289078,257 @@ "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", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "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" @@ -285642,186 +289349,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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": "string", - "nullable": true, - "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" @@ -285842,32 +289384,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" }, @@ -285879,19 +289417,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": { @@ -285919,25 +289471,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" }, @@ -285949,23 +289501,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": { @@ -323441,7 +326979,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": { @@ -323488,6 +327032,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -331644,6 +335194,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/api.github.com/api.github.com.2026-03-10.yaml b/descriptions/api.github.com/api.github.com.2026-03-10.yaml index 84d89bb41a..687e893caf 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions/api.github.com/api.github.com.2026-03-10.yaml @@ -26625,6 +26625,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 @@ -52858,6 +52860,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 @@ -52906,7 +52910,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" @@ -52991,7 +52995,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" @@ -76967,6 +76971,72 @@ x-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: |- @@ -79394,7 +79464,7 @@ x-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. @@ -79402,8 +79472,8 @@ x-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: @@ -79447,20 +79517,19 @@ x-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. @@ -79468,8 +79537,8 @@ x-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: @@ -79513,20 +79582,19 @@ x-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. @@ -79534,8 +79602,8 @@ x-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: @@ -79579,7 +79647,7 @@ x-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 @@ -79592,7 +79660,7 @@ x-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. @@ -79600,8 +79668,8 @@ x-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: @@ -79645,7 +79713,7 @@ x-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 @@ -79658,7 +79726,7 @@ x-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. @@ -79666,8 +79734,8 @@ x-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: @@ -79711,7 +79779,7 @@ x-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 @@ -79724,19 +79792,18 @@ x-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 @@ -79750,7 +79817,7 @@ x-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 @@ -79778,7 +79845,7 @@ x-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 @@ -79786,21 +79853,23 @@ x-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 @@ -79814,7 +79883,7 @@ x-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 @@ -79842,7 +79911,7 @@ x-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 @@ -79850,19 +79919,24 @@ x-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 @@ -79876,7 +79950,7 @@ x-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 @@ -79904,7 +79978,7 @@ x-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 @@ -79912,17 +79986,19 @@ x-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: @@ -79966,7 +80042,7 @@ x-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 @@ -79977,15 +80053,16 @@ x-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 @@ -79999,7 +80076,7 @@ x-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 @@ -80027,7 +80104,7 @@ x-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 @@ -80035,24 +80112,19 @@ x-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 @@ -80066,7 +80138,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: sponsorship + example: security_advisory schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80094,7 +80166,7 @@ x-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 @@ -80102,20 +80174,18 @@ x-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 @@ -80129,7 +80199,7 @@ x-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 @@ -80157,7 +80227,7 @@ x-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 @@ -80165,19 +80235,22 @@ x-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: @@ -80221,7 +80294,7 @@ x-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 @@ -80232,17 +80305,15 @@ x-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: @@ -80286,7 +80357,7 @@ x-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 @@ -80297,15 +80368,144 @@ x-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: + - 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: sponsorship + 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-sponsorship-edited" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + 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 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: + - 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: sponsorship + 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-sponsorship-pending-cancellation" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + sponsorship-pending-tier-change: + 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 externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -96593,6 +96793,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 @@ -109654,6 +109856,144 @@ components: nullable: true closure_request_reviewer: "$ref": "#/components/schemas/nullable-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: + "$ref": "#/components/schemas/nullable-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 + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + "$ref": "#/components/schemas/nullable-simple-user" + resolution_comment: + type: string + description: An optional comment to resolve an alert. + nullable: true + 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 + description: The provider of the secret that was detected. + nullable: true + provider_slug: + type: string + 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. + nullable: true + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the detected secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple repositories + under the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert is base64 + encoded + nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-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: + "$ref": "#/components/schemas/nullable-simple-user" + closure_request_comment: + type: string + description: An optional comment from the closure request author. + nullable: true + closure_request_reviewer_comment: + type: string + description: An optional comment from the closure request reviewer. + nullable: true + closure_request_reviewer: + "$ref": "#/components/schemas/nullable-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. @@ -122299,6 +122639,8 @@ components: nullable: true closure_request_reviewer: "$ref": "#/components/schemas/nullable-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. @@ -193964,53 +194306,2246 @@ 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + 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 + nullable: true + properties: + commit_message: + description: Commit message for the merge commit. + type: string + nullable: true + commit_title: + description: Title for the merge commit message. + type: string + nullable: true + enabled_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - 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 + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merged_at: + type: string + nullable: true + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - 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: @@ -194175,7 +196710,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -194247,7 +196781,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -194577,28 +197110,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 @@ -194731,28 +197242,6 @@ components: nullable: true 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: @@ -195197,28 +197686,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 @@ -195351,28 +197818,6 @@ components: nullable: true 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: @@ -195704,7 +198149,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -196186,24 +198630,321 @@ 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: integer + nullable: true + 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 + nullable: true + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - 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 + nullable: true + 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: @@ -196471,7 +199212,6 @@ components: commit_title: description: Title for the merge commit message. type: string - nullable: true enabled_by: title: User type: object @@ -197132,14 +199872,12 @@ components: properties: label: type: string - nullable: true ref: type: string repo: title: Repository description: A git repository type: object - nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -197940,7 +200678,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198048,15 +200785,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -198241,7 +200969,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198386,7 +201113,6 @@ components: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer - nullable: true original_position: description: The index of the original line in the diff to which the comment applies. @@ -198546,7 +201272,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198595,22 +201320,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: @@ -198706,6 +201433,8 @@ components: - too heated - spam - null + additions: + type: integer assignee: title: User type: object @@ -198767,6 +201496,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -198838,6 +201568,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -198870,6 +201601,7 @@ components: commit_title: description: Title for the merge commit message. type: string + nullable: true enabled_by: title: User type: object @@ -199166,6 +201898,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 @@ -199298,6 +202052,28 @@ components: nullable: true 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: @@ -199509,33 +202285,46 @@ components: body: type: string nullable: true + changed_files: + type: integer closed_at: type: string nullable: true + 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 + nullable: true ref: type: string repo: title: Repository description: A git repository type: object + nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -199740,6 +202529,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 @@ -199872,6 +202683,28 @@ components: nullable: true 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: @@ -200124,9 +202957,91 @@ components: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true merged_at: type: string nullable: true + format: date-time + merged_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -200203,6 +203118,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -200268,10 +203184,15 @@ 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 + nullable: true requested_reviewers: type: array items: @@ -200336,6 +203257,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -200443,6 +203365,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -200547,10 +203478,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 @@ -200559,9 +203493,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 @@ -200627,6 +203563,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -200659,7 +203596,6 @@ components: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -200671,313 +203607,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 - nullable: true - 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 - nullable: true - 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 - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: integer - nullable: true - 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 - nullable: true - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: string - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - 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 - nullable: true - format: date-time required: - action - - thread + - number - pull_request - repository + - sender webhook-pull-request-synchronize: title: pull_request synchronize event type: object @@ -213393,6 +216033,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 @@ -244611,6 +247299,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 @@ -244654,6 +247345,9 @@ components: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -251780,6 +254474,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/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 8f611a8ca7..be2490cec8 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -36345,6 +36345,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": { @@ -72546,6 +72552,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": { @@ -72614,7 +72626,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -72739,7 +72751,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/secret-scanning-alert" + "$ref": "#/components/schemas/secret-scanning-alert-with-metadata" }, "examples": { "default": { @@ -106336,6 +106348,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.", @@ -109792,11 +109897,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" }, @@ -109863,7 +109968,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-created" } } } @@ -109874,7 +109979,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -109885,11 +109989,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" }, @@ -109956,7 +110060,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-removed" } } } @@ -109967,7 +110071,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -109978,11 +110081,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" }, @@ -110049,7 +110152,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -110071,11 +110174,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" }, @@ -110142,7 +110245,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -110164,11 +110267,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" }, @@ -110235,7 +110338,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -110257,13 +110360,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": [ { @@ -110285,7 +110388,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_scan", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110328,7 +110431,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -110341,7 +110444,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_scan", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -110350,13 +110453,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": [ { @@ -110378,7 +110481,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110421,7 +110524,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -110434,20 +110537,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": [ { @@ -110469,7 +110574,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_scan", "schema": { "type": "string" } @@ -110512,7 +110617,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -110525,18 +110630,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" }, @@ -110603,7 +110710,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -110623,12 +110730,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": [ { @@ -110650,7 +110758,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_and_analysis", + "example": "security_advisory", "schema": { "type": "string" } @@ -110693,7 +110801,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -110706,22 +110814,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": [ { @@ -110743,7 +110849,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_advisory", "schema": { "type": "string" } @@ -110786,7 +110892,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -110799,20 +110905,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": [ { @@ -110834,7 +110939,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_and_analysis", "schema": { "type": "string" } @@ -110877,7 +110982,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -110890,18 +110995,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" }, @@ -110968,7 +111075,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -110988,11 +111095,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" }, @@ -111059,7 +111166,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -111079,11 +111186,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" }, @@ -111150,7 +111257,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -111170,11 +111277,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" }, @@ -111241,7 +111348,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -111261,13 +111368,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": [ { @@ -111289,7 +111396,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111332,7 +111439,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -111345,22 +111452,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": [ { @@ -111382,7 +111487,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111425,7 +111530,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -111438,21 +111543,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": [ { @@ -111474,7 +111578,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "status", + "example": "star", "schema": { "type": "string" } @@ -111517,7 +111621,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -111530,7 +111634,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111539,13 +111643,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": [ { @@ -111567,7 +111671,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "star", "schema": { "type": "string" } @@ -111610,7 +111714,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -111623,7 +111727,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111632,13 +111736,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": [ { @@ -111660,7 +111763,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "status", "schema": { "type": "string" } @@ -111703,7 +111806,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" } } } @@ -111716,7 +111819,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "status", "supported-webhook-types": [ "repository", "organization", @@ -111725,11 +111828,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" }, @@ -111796,7 +111899,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -111818,11 +111921,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" }, @@ -111889,7 +111992,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -111911,12 +112014,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": [ { @@ -111938,7 +112042,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team_add", + "example": "sub_issues", "schema": { "type": "string" } @@ -111981,7 +112085,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -111994,7 +112098,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "sub-issues", "supported-webhook-types": [ "repository", "organization", @@ -112003,13 +112107,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": [ { @@ -112031,7 +112135,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "sub_issues", "schema": { "type": "string" } @@ -112074,7 +112178,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -112087,22 +112191,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": [ { @@ -112124,7 +112227,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "team_add", "schema": { "type": "string" } @@ -112167,7 +112270,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -112180,20 +112283,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" }, @@ -112260,7 +112363,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -112282,11 +112385,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" }, @@ -112353,7 +112456,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -112375,11 +112478,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" }, @@ -112446,7 +112549,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-deleted" } } } @@ -112468,13 +112571,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": [ { @@ -112496,7 +112599,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "watch", + "example": "team", "schema": { "type": "string" } @@ -112539,7 +112642,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-edited" } } } @@ -112552,21 +112655,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": [ { @@ -112588,7 +112692,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_dispatch", + "example": "team", "schema": { "type": "string" } @@ -112631,7 +112735,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" } } } @@ -112644,20 +112748,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": [ { @@ -112679,7 +112785,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "watch", "schema": { "type": "string" } @@ -112722,7 +112828,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-watch-started" } } } @@ -112735,9 +112841,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "watch", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -112745,13 +112850,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": [ { @@ -112773,7 +112877,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" } @@ -132690,6 +132979,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." @@ -150264,6 +150556,178 @@ } } }, + "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": { + "$ref": "#/components/schemas/nullable-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", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "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.", + "nullable": true + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", + "nullable": true + }, + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-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": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true + }, + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true + }, + "closure_request_reviewer": { + "$ref": "#/components/schemas/nullable-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": "string", @@ -166714,6 +167178,9 @@ }, "closure_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" + }, + "metadata": { + "$ref": "#/components/schemas/secret-scanning-alert-metadata" } } }, @@ -263114,8 +263581,2911 @@ "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", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "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": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "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": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "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", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, "url": { @@ -263557,23 +266927,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" @@ -263761,23 +267114,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" }, @@ -263833,11 +267169,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": [ @@ -264356,23 +267687,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" @@ -264560,23 +267874,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" }, @@ -264632,11 +267929,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": [ @@ -265005,8 +268297,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -265644,35 +268935,397 @@ "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": "integer", + "nullable": true + }, + "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", + "nullable": true + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "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", + "nullable": true, + "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": [ @@ -265689,14 +269342,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": { @@ -266060,8 +269713,7 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string", - "nullable": true + "type": "string" }, "enabled_by": { "title": "User", @@ -266937,8 +270589,7 @@ "type": "object", "properties": { "label": { - "type": "string", - "nullable": true + "type": "string" }, "ref": { "type": "string" @@ -266947,7 +270598,6 @@ "title": "Repository", "description": "A git repository", "type": "object", - "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -268009,8 +271659,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -268152,16 +271801,7 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "id" ] } ] @@ -268408,8 +272048,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -268589,8 +272228,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", - "nullable": true + "type": "integer" }, "original_position": { "description": "The index of the original line in the diff to which the comment applies.", @@ -268790,8 +272428,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -268875,14 +272512,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": { @@ -268891,11 +272528,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": { @@ -269028,6 +272668,9 @@ null ] }, + "additions": { + "type": "integer" + }, "assignee": { "title": "User", "type": "object", @@ -269107,7 +272750,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -269204,7 +272848,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -269246,7 +272891,8 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": "string", + "nullable": true }, "enabled_by": { "title": "User", @@ -269645,6 +273291,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" @@ -269832,6 +273495,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" }, @@ -269887,6 +273567,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": [ @@ -270096,33 +273781,49 @@ "type": "string", "nullable": true }, + "changed_files": { + "type": "integer" + }, "closed_at": { "type": "string", - "nullable": true + "nullable": true, + "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", + "nullable": true }, "ref": { "type": "string" @@ -270131,6 +273832,7 @@ "title": "Repository", "description": "A git repository", "type": "object", + "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -270403,6 +274105,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" @@ -270590,6 +274309,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" }, @@ -270645,6 +274381,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": [ @@ -270908,13 +274649,125 @@ "locked": { "type": "boolean" }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, "merge_commit_sha": { "type": "string", "nullable": true }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, "merged_at": { "type": "string", - "nullable": true + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] }, "milestone": { "title": "Milestone", @@ -271013,7 +274866,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -271103,12 +274957,17 @@ "type": "string" }, "number": { + "description": "Number uniquely identifying the pull request within its repository.", "type": "integer" }, "patch_url": { "type": "string", "format": "uri" }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, "requested_reviewers": { "type": "array", "items": { @@ -271192,7 +275051,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -271334,7 +275194,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -271476,11 +275345,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", @@ -271492,10 +275365,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", @@ -271581,7 +275456,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -271623,7 +275499,6 @@ "requested_teams", "labels", "milestone", - "draft", "commits_url", "review_comments_url", "review_comment_url", @@ -271634,7 +275509,8 @@ "_links", "author_association", "auto_merge", - "active_lock_reason" + "active_lock_reason", + "draft" ] }, "repository": { @@ -271642,393 +275518,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", - "nullable": true - }, - "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", - "nullable": true - }, - "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", - "nullable": true - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": "integer", - "nullable": true - }, - "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", - "nullable": true - }, - "start_side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": "string", - "nullable": true, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "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", - "nullable": true, - "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": [ @@ -288394,18 +291907,257 @@ "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", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "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" @@ -288426,186 +292178,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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": "string", - "nullable": true, - "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" @@ -288626,32 +292213,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" }, @@ -288663,19 +292246,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": { @@ -288703,25 +292300,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" }, @@ -288733,23 +292330,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": { @@ -326529,7 +330112,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": { @@ -326576,6 +330165,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -334800,6 +338395,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/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 2bc5a244de..f9d628f33f 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -26756,6 +26756,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 @@ -53118,6 +53120,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 @@ -53166,7 +53170,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" @@ -53251,7 +53255,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" @@ -77315,6 +77319,72 @@ x-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: |- @@ -79742,7 +79812,7 @@ x-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. @@ -79750,8 +79820,8 @@ x-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: @@ -79795,20 +79865,19 @@ x-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. @@ -79816,8 +79885,8 @@ x-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: @@ -79861,20 +79930,19 @@ x-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. @@ -79882,8 +79950,8 @@ x-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: @@ -79927,7 +79995,7 @@ x-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 @@ -79940,7 +80008,7 @@ x-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. @@ -79948,8 +80016,8 @@ x-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: @@ -79993,7 +80061,7 @@ x-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 @@ -80006,7 +80074,7 @@ x-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. @@ -80014,8 +80082,8 @@ x-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: @@ -80059,7 +80127,7 @@ x-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 @@ -80072,19 +80140,18 @@ x-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 @@ -80098,7 +80165,7 @@ x-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 @@ -80126,7 +80193,7 @@ x-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 @@ -80134,21 +80201,23 @@ x-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 @@ -80162,7 +80231,7 @@ x-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 @@ -80190,7 +80259,7 @@ x-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 @@ -80198,19 +80267,24 @@ x-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 @@ -80224,7 +80298,7 @@ x-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 @@ -80252,7 +80326,7 @@ x-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 @@ -80260,17 +80334,19 @@ x-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: @@ -80314,7 +80390,7 @@ x-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 @@ -80325,15 +80401,16 @@ x-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 @@ -80347,7 +80424,7 @@ x-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 @@ -80375,7 +80452,7 @@ x-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 @@ -80383,24 +80460,19 @@ x-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 @@ -80414,7 +80486,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: sponsorship + example: security_advisory schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -80442,7 +80514,7 @@ x-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 @@ -80450,20 +80522,18 @@ x-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 @@ -80477,7 +80547,7 @@ x-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 @@ -80505,7 +80575,7 @@ x-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 @@ -80513,19 +80583,22 @@ x-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: @@ -80569,7 +80642,7 @@ x-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 @@ -80580,17 +80653,15 @@ x-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: @@ -80634,7 +80705,7 @@ x-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 @@ -80645,15 +80716,144 @@ x-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: + - 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: sponsorship + 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-sponsorship-edited" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + 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 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: + - 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: sponsorship + 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-sponsorship-pending-cancellation" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + sponsorship-pending-tier-change: + 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 externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -97697,6 +97897,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 @@ -111072,6 +111274,144 @@ components: nullable: true closure_request_reviewer: "$ref": "#/components/schemas/nullable-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: + "$ref": "#/components/schemas/nullable-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 + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + "$ref": "#/components/schemas/nullable-simple-user" + resolution_comment: + type: string + description: An optional comment to resolve an alert. + nullable: true + 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 + description: The provider of the secret that was detected. + nullable: true + provider_slug: + type: string + 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. + nullable: true + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the detected secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple repositories + under the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert is base64 + encoded + nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-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: + "$ref": "#/components/schemas/nullable-simple-user" + closure_request_comment: + type: string + description: An optional comment from the closure request author. + nullable: true + closure_request_reviewer_comment: + type: string + description: An optional comment from the closure request reviewer. + nullable: true + closure_request_reviewer: + "$ref": "#/components/schemas/nullable-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. @@ -123684,6 +124024,8 @@ components: nullable: true closure_request_reviewer: "$ref": "#/components/schemas/nullable-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. @@ -195781,76 +196123,2300 @@ 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + 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 + nullable: true + properties: + commit_message: + description: Commit message for the merge commit. + type: string + nullable: true + commit_title: + description: Title for the merge commit message. + type: string + nullable: true + enabled_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - 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 + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merge_commit_sha: + type: string + nullable: true + merged_at: + type: string + nullable: true + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - 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: @@ -196015,7 +198581,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -196087,7 +198652,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -196417,28 +198981,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 @@ -196571,28 +199113,6 @@ components: nullable: true 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: @@ -196633,12 +199153,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: @@ -197043,28 +199557,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 @@ -197197,28 +199689,6 @@ components: nullable: true 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: @@ -197259,12 +199729,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: @@ -197559,7 +200023,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198042,24 +200505,314 @@ 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: integer + nullable: true + 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 + nullable: true + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - 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 + nullable: true + 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 @@ -198067,14 +200820,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: @@ -198342,7 +201095,6 @@ components: commit_title: description: Title for the merge commit message. type: string - nullable: true enabled_by: title: User type: object @@ -199003,14 +201755,12 @@ components: properties: label: type: string - nullable: true ref: type: string repo: title: Repository description: A git repository type: object - nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -199814,7 +202564,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -199922,15 +202671,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -200115,7 +202855,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -200261,7 +203000,6 @@ components: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer - nullable: true original_position: description: The index of the original line in the diff to which the comment applies. @@ -200421,7 +203159,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -200478,22 +203215,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: @@ -200589,6 +203328,8 @@ components: - too heated - spam - null + additions: + type: integer assignee: title: User type: object @@ -200650,6 +203391,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -200721,6 +203463,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -200753,6 +203496,7 @@ components: commit_title: description: Title for the merge commit message. type: string + nullable: true enabled_by: title: User type: object @@ -201049,6 +203793,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 @@ -201181,6 +203947,28 @@ components: nullable: true 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: @@ -201221,6 +204009,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: @@ -201392,33 +204186,46 @@ components: body: type: string nullable: true + changed_files: + type: integer closed_at: type: string nullable: true + 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 + nullable: true ref: type: string repo: title: Repository description: A git repository type: object + nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -201623,6 +204430,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 @@ -201755,6 +204584,28 @@ components: nullable: true 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: @@ -201795,6 +204646,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: @@ -202007,12 +204864,94 @@ components: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean merge_commit_sha: type: string nullable: true + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true merged_at: type: string nullable: true + format: date-time + merged_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -202089,6 +205028,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -202154,10 +205094,15 @@ 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 + nullable: true requested_reviewers: type: array items: @@ -202222,6 +205167,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -202329,6 +205275,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -202433,10 +205388,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 @@ -202445,9 +205403,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 @@ -202513,6 +205473,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -202546,7 +205507,6 @@ components: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -202558,314 +205518,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 - nullable: true - 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 - nullable: true - 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 - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: integer - nullable: true - 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 - nullable: true - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: string - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - 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 - nullable: true - 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 @@ -215412,6 +218083,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 @@ -246830,6 +249549,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 @@ -246873,6 +249595,9 @@ components: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -254036,6 +256761,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 95e708aa24..f9785ef32e 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -212389,6 +212389,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." @@ -213686,6 +213729,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." @@ -215052,6 +215138,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." @@ -217159,6 +217288,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." @@ -218481,6 +218653,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." @@ -219843,6 +220058,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." @@ -221426,6 +221684,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": { @@ -560437,6 +560713,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." @@ -562294,6 +562613,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." @@ -563458,6 +563820,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." @@ -564830,6 +565235,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." @@ -566956,6 +567404,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." @@ -568135,6 +568626,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." @@ -569503,6 +570037,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." @@ -571102,6 +571679,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": { @@ -573566,6 +574161,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -573594,7 +574211,13 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ] } } } @@ -574888,6 +575511,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -574936,6 +575581,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -1294462,11 +1295113,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" }, @@ -1294533,21 +1295184,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).\"", @@ -1296002,7 +1296647,8 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": "string", + "nullable": true }, "ref": { "type": "string" @@ -1296011,6 +1296657,7 @@ "title": "Repository", "description": "A git repository", "type": "object", + "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1296284,7 +1296931,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", @@ -1296293,7 +1296940,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", @@ -1296930,7 +1297577,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1299049,8 +1299697,6 @@ "required": [ "action", "number", - "before", - "after", "pull_request", "repository", "sender" @@ -1299076,11 +1299722,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" }, @@ -1299147,110 +1299793,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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "after": { + "type": "string" + }, + "before": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -1299894,8 +1300450,7 @@ "type": "object", "properties": { "label": { - "type": "string", - "nullable": true + "type": "string" }, "ref": { "type": "string" @@ -1300707,8 +1301262,7 @@ "type": "object", "properties": { "label": { - "type": "string", - "nullable": true + "type": "string" }, "ref": { "type": "string" @@ -1300717,7 +1301271,6 @@ "title": "Repository", "description": "A git repository", "type": "object", - "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1300991,7 +1301544,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", @@ -1301000,7 +1301553,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", @@ -1301637,8 +1302190,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -1303757,8 +1304309,11 @@ "required": [ "action", "number", + "before", + "after", "pull_request", - "repository" + "repository", + "sender" ] } } @@ -1303781,11 +1304336,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" }, @@ -1303852,13 +1304407,109 @@ "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -1303950,47 +1304601,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", - "nullable": true - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "number": { "description": "The pull request number.", "type": "integer" @@ -1304544,7 +1305154,8 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": "string", + "nullable": true }, "ref": { "type": "string" @@ -1305640,7 +1306251,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", @@ -1305649,7 +1306260,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", @@ -1306286,7 +1306897,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1308406,8 +1309018,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ] } } @@ -1308430,11 +1309041,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" }, @@ -1308501,13 +1309112,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": { @@ -1308599,6 +1309210,47 @@ "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", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "number": { "description": "The pull request number.", "type": "integer" @@ -1308892,7 +1309544,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1308989,7 +1309642,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1309031,7 +1309685,8 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": "string", + "nullable": true }, "enabled_by": { "title": "User", @@ -1309961,7 +1310616,8 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": "string", + "nullable": true }, "ref": { "type": "string" @@ -1310244,7 +1310900,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", @@ -1310253,7 +1310909,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", @@ -1311003,7 +1311659,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1311187,7 +1311844,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1311329,7 +1311987,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -1311582,7 +1312249,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1313022,12 +1313690,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": [ { @@ -1313049,7 +1313718,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "push", + "example": "pull_request", "schema": { "type": "string" } @@ -1313092,151 +1313761,14 @@ "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": { + "action": { "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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", - "nullable": true, - "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" + "enum": [ + "unlocked" + ] }, "enterprise": { "title": "Enterprise", @@ -1313306,126 +1313838,6 @@ "avatar_url" ] }, - "forced": { - "description": "Whether this push was a force push of the `ref`.", - "type": "boolean" - }, - "head_commit": { - "title": "Commit", - "type": "object", - "nullable": true, - "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", - "nullable": true, - "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", - "nullable": true, - "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).\"", @@ -1313447,6 +1313859,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.", @@ -1313520,351 +1313936,144 @@ "description" ] }, - "pusher": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": "string", - "nullable": true, - "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": { - "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", - "nullable": true - }, - "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", - "nullable": true - }, - "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", - "nullable": true - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", + "_links": { "type": "object", - "nullable": true, "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", - "nullable": true, - "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", "nullable": true, - "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", "nullable": true, @@ -1313959,756 +1314168,169 @@ "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": { - "nullable": true, - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": "string", - "nullable": true - }, - "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "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" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "MDQ6VXNlcjU4MzIzMQ==" - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "registry_package": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "owner": { + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", "type": "object", + "nullable": true, "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", + "nullable": true }, - "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", - "nullable": true, - "properties": { - "author": { + "enabled_by": { + "title": "User", "type": "object", + "nullable": true, "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true }, "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" @@ -1314716,32 +1314338,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" @@ -1314749,428 +1314385,399 @@ }, "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", - "nullable": true + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false }, - "manifest": { - "type": "object", - "nullable": true + "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", - "nullable": true, - "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" - } - ], - "nullable": true + "allow_update_branch": { + "type": "boolean" }, - "bugs": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], - "nullable": true + "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": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], - "nullable": true + "collaborators_url": { + "type": "string", + "format": "uri-template" }, - "git_head": { - "type": "string" + "comments_url": { + "type": "string", + "format": "uri-template" }, - "homepage": { - "type": "string" + "commits_url": { + "type": "string", + "format": "uri-template" }, - "license": { - "type": "string" + "compare_url": { + "type": "string", + "format": "uri-template" }, - "main": { - "type": "string" + "contents_url": { + "type": "string", + "format": "uri-template" }, - "repository": { + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { "oneOf": [ { - "type": "string" + "type": "integer" }, { - "type": "object" + "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", "nullable": true }, - "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": { + "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" }, - "maintainers": { - "type": "array", - "items": { - "type": "string" - } + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true }, - "contributors": { - "type": "array", - "items": { - "type": "string" - } + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true }, - "engines": { - "type": "object" + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false }, - "keywords": { - "type": "array", - "items": { - "type": "string" - } + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true }, - "files": { - "type": "array", - "items": { - "type": "string" - } + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] }, - "bin": { - "type": "object" + "homepage": { + "type": "string", + "nullable": true }, - "man": { - "type": "object" + "hooks_url": { + "type": "string", + "format": "uri" }, - "directories": { - "oneOf": [ - { + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { "type": "string" }, - { - "type": "object" + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" } - ], - "nullable": true + }, + "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": { - "type": "string" + "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" + ] }, - "installation_command": { - "type": "string" + "merges_url": { + "type": "string", + "format": "uri" }, - "release_id": { - "type": "integer" + "milestones_url": { + "type": "string", + "format": "uri-template" }, - "commit_oid": { + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", "type": "string" }, - "published_via_actions": { - "type": "boolean" + "node_id": { + "type": "string" }, - "deleted_by_id": { + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { "type": "integer" - } - } - }, - "nuget_metadata": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "integer" - } - ], - "nullable": true - }, - "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", - "nullable": true - }, - "name": { - "type": "string" - }, - "sha1": { - "type": "string", - "nullable": true - }, - "sha256": { - "type": "string", - "nullable": true - }, - "size": { - "type": "integer" - }, - "state": { - "type": "string", - "nullable": true - }, - "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": { + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", "type": "object", + "nullable": true, "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true }, "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" @@ -1315178,1900 +1314785,2069 @@ "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" } - } - }, - "created_at": { - "type": "string" - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string", - "nullable": true + }, + "required": [ + "login", + "id" + ] }, - "prerelease": { + "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" }, - "published_at": { + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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" }, - "tag_name": { + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "target_commitish": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { "type": "string" }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "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", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "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" }, - "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" - } + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "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" } - }, - "platform": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { + ] + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" } }, - "repo": { - "type": "string" + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } }, - "dependencies": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" } }, - "commit_oid": { + "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": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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" } - } - }, - "summary": { - "type": "string" - }, - "tag_name": { - "type": "string" - }, - "target_commitish": { - "type": "string" - }, - "target_oid": { - "type": "string" + }, + "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" + ] }, - "updated_at": { + "sha": { "type": "string" }, - "version": { - "type": "string" + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] } }, "required": [ - "id", - "version", - "name", - "description", - "summary", - "html_url", - "metadata", - "package_files", - "installation_command", - "package_url" + "label", + "ref", + "sha", + "user", + "repo" ] }, - "registry": { - "type": "object", - "nullable": true, - "properties": { - "about_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" + "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", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } }, - "vendor": { - "type": "string" - } + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] } }, - "updated_at": { + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { "type": "string", "nullable": true - } - }, - "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", - "example": 42, - "type": "integer", - "format": "int64" }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "mergeable": { + "type": "boolean", + "nullable": true }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" + "mergeable_state": { + "type": "string" }, - "full_name": { + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { "type": "string", - "example": "octocat/Hello-World" + "nullable": true, + "format": "date-time" }, - "license": { - "title": "License Simple", - "description": "License Simple", + "merged_by": { + "title": "User", "type": "object", + "nullable": true, "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { + "avatar_url": { "type": "string", - "example": "MIT License" + "format": "uri" }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "deleted": { + "type": "boolean" }, - "spdx_id": { + "email": { "type": "string", - "nullable": true, - "example": "MIT" + "nullable": true }, - "node_id": { + "events_url": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "format": "uri-template" }, - "html_url": { + "followers_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 }, - "node_id": { + "following_url": { "type": "string", - "example": "MDQ6VXNlcjE=" + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri-template" }, "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "login": { + "type": "string" }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "name": { + "type": "string" }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "node_id": { + "type": "string" }, - "subscriptions_url": { + "organizations_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" }, - "organizations_url": { + "received_events_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri" }, "type": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "Bot", + "User", + "Organization" + ] }, - "starred_at": { + "url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri" }, "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "id" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", + "nullable": true, "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { + "closed_at": { "type": "string", - "example": "octocat" + "nullable": true, + "format": "date-time" }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 + "closed_issues": { + "type": "integer" }, - "node_id": { + "created_at": { "type": "string", - "example": "MDQ6VXNlcjE=" + "format": "date-time" }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] }, - "gravatar_id": { + "description": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "url": { + "due_on": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "nullable": true, + "format": "date-time" }, "html_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "id": { + "type": "integer" }, - "organizations_url": { + "labels_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "uri" }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "node_id": { + "type": "string" }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "number": { + "description": "The number of the milestone.", + "type": "integer" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "open_issues": { + "type": "integer" }, - "type": { + "state": { + "description": "The state of the milestone.", "type": "string", - "example": "User" + "enum": [ + "open", + "closed" + ] }, - "site_admin": { - "type": "boolean" + "title": { + "description": "The title of the milestone.", + "type": "string" }, - "starred_at": { + "updated_at": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "date-time" }, - "user_view_type": { + "url": { "type": "string", - "example": "public" + "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 + "node_id": { + "type": "string" }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" }, - "default_branch": { - "description": "The default branch of the repository.", + "patch_url": { "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 + "format": "uri" }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "rebaseable": { "type": "boolean", - "example": true + "nullable": true }, - "topics": { + "requested_reviewers": { "type": "array", "items": { - "type": "string" - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } }, - "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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" + } }, - "site_admin": { - "type": "boolean" - } + "required": [ + "name", + "id" + ] } - }, - "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": { + ] + } + }, + "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", + "nullable": true + }, + "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" - } - }, - "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" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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" + } }, - "pull": { - "type": "boolean" - } + "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" } }, - "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" - } + "required": [ + "name", + "id" + ] } }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { + "review_comment_url": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" + "format": "uri-template" }, - "watchers": { + "review_comments": { "type": "integer" }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "action", - "registry_package", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "registry_package", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "registry-package-updated": { - "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", - "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": [ - "updated" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", + "review_comments_url": { "type": "string", - "nullable": true, "format": "uri" }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" + "enum": [ + "open", + "closed" + ] }, - "avatar_url": { + "statuses_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "MDQ6VXNlcjU4MzIzMQ==" - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" }, - "id": { - "type": "integer", - "example": 1 + "title": { + "description": "The title of the pull request.", + "type": "string" }, - "node_id": { + "updated_at": { "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "format": "date-time" }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "registry_package": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "nullable": true - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" + "format": "uri" }, - "owner": { + "user": { + "title": "User", "type": "object", + "nullable": true, "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true }, "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" + "type": "integer", + "format": "int64" }, "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" @@ -1317079,457 +1316855,47 @@ }, "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", - "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", - "nullable": true, - "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", - "nullable": true - }, - "name": { - "type": "string" - }, - "sha1": { - "type": "string", - "nullable": true - }, - "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" + "id" ] - }, - "registry": { - "type": "object", - "nullable": true - }, - "updated_at": { - "type": "string" } }, "required": [ + "url", "id", - "name", - "namespace", - "description", - "ecosystem", - "package_type", + "node_id", "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", "created_at", "updated_at", - "owner", - "package_version", - "registry" + "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": { @@ -1318890,7 +1318256,9 @@ }, "required": [ "action", - "registry_package", + "number", + "pull_request", + "repository", "sender" ] } @@ -1318905,7 +1318273,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -1318914,13 +1318282,12 @@ } } }, - "release-created": { + "push": { "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 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#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1318942,7 +1318309,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "push", "schema": { "type": "string" } @@ -1318985,789 +1318352,872 @@ "content": { "application/json": { "schema": { - "title": "release created event", + "title": "push event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "created" - ] + "after": { + "description": "The SHA of the most recent commit on `ref` after the push.", + "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).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] + "base_ref": { + "type": "string", + "nullable": true }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "MDQ6VXNlcjU4MzIzMQ==" - } - }, - "required": [ - "id", - "node_id" - ] + "before": { + "description": "The SHA of the most recent commit on `ref` before the push.", + "type": "string" }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "release": { - "title": "Release", - "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", - "type": "object", - "properties": { - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", + "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": { - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "content_type": { - "type": "string" - }, - "created_at": { + "date": { "type": "string", "format": "date-time" }, - "download_count": { - "type": "integer" - }, - "id": { - "type": "integer" - }, - "label": { + "email": { "type": "string", - "nullable": true + "nullable": true, + "format": "email" }, "name": { - "description": "The file name of the asset.", + "description": "The git author's name.", "type": "string" }, - "node_id": { + "username": { "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { "type": "string", "format": "date-time" }, - "uploader": { - "title": "User", - "type": "object", + "email": { + "type": "string", "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "format": "email" }, - "url": { - "type": "string", - "format": "uri" + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" } }, "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" + "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" } }, - "assets_url": { + "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).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { "type": "string", "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "forced": { + "description": "Whether this push was a force push of the `ref`.", + "type": "boolean" + }, + "head_commit": { + "title": "Commit", + "type": "object", + "nullable": true, + "properties": { + "added": { + "description": "An array of files added in the commit.", + "type": "array", + "items": { + "type": "string" + } }, "author": { - "title": "User", + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", "type": "object", - "nullable": true, "properties": { - "avatar_url": { + "date": { "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "format": "date-time" }, "email": { "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" + "nullable": true, + "format": "email" }, "name": { + "description": "The git author's name.", "type": "string" }, - "node_id": { + "username": { "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { "type": "string", - "format": "uri" + "format": "date-time" }, - "type": { + "email": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "nullable": true, + "format": "email" }, - "url": { - "type": "string", - "format": "uri" + "name": { + "description": "The git author's name.", + "type": "string" }, - "user_view_type": { + "username": { "type": "string" } }, "required": [ - "login", - "id" + "email", + "name" ] }, - "body": { - "type": "string", - "nullable": true + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time" + "id": { + "type": "string" }, - "updated_at": { + "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", - "nullable": true, "format": "date-time" }, - "discussion_url": { + "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).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 }, - "draft": { - "description": "Whether the release is a draft or published", - "type": "boolean" - }, - "html_url": { + "node_id": { + "description": "The global node ID of the installation.", "type": "string", - "format": "uri" + "example": "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", + "example": "github" }, "id": { - "type": "integer" + "type": "integer", + "example": 1 }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, - "name": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { "type": "string", + "example": "A great organization", "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "pusher": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" }, - "node_id": { + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", "type": "string" }, - "prerelease": { - "description": "Whether the release is identified as a prerelease or a full release.", + "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" }, - "published_at": { + "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", - "nullable": true, - "format": "date-time" + "format": "uri-template" }, - "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": { + "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" }, - "url": { + { "type": "string", - "format": "uri" + "format": "date-time" } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" ] }, - "tag_name": { - "description": "The name of the tag.", + "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" }, - "tarball_url": { + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { "type": "string", - "nullable": true, "format": "uri" }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", + "description": { + "type": "string", + "nullable": true + }, + "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" }, - "upload_url": { + "git_commits_url": { "type": "string", "format": "uri-template" }, - "url": { + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { "type": "string", "format": "uri" }, - "zipball_url": { + "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", + "nullable": true + }, + "hooks_url": { "type": "string", - "nullable": true, "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": { + }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { "description": "Unique identifier of the repository", - "example": 42, "type": "integer", "format": "int64" }, - "node_id": { + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "format": "uri-template" }, - "name": { - "description": "The name of the repository.", + "issue_events_url": { "type": "string", - "example": "Team Environment" + "format": "uri-template" }, - "full_name": { + "issues_url": { "type": "string", - "example": "octocat/Hello-World" + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" }, "license": { - "title": "License Simple", - "description": "License Simple", + "title": "License", "type": "object", + "nullable": true, "properties": { "key": { - "type": "string", - "example": "mit" + "type": "string" }, "name": { - "type": "string", - "example": "MIT License" + "type": "string" }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "node_id": { + "type": "string" }, "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "type": "string" }, - "html_url": { + "url": { "type": "string", + "nullable": true, "format": "uri" } }, "required": [ "key", "name", - "url", "spdx_id", + "url", "node_id" - ], - "nullable": true + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "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": { - "title": "Simple User", - "description": "A GitHub user.", + "type": "string" + }, + "owner": { + "title": "User", "type": "object", + "nullable": true, "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, "avatar_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri" }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "deleted": { + "type": "boolean" }, - "url": { + "email": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "nullable": true }, - "html_url": { + "events_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "format": "uri-template" }, "followers_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "format": "uri" }, "following_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri-template" }, "gists_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "format": "uri-template" }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "gravatar_id": { + "type": "string" }, - "subscriptions_url": { + "html_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" }, "organizations_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri" }, "type": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "Bot", + "User", + "Organization" + ] }, - "starred_at": { + "url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri" }, "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "forks": { - "type": "integer" + "id" + ] }, "permissions": { "type": "object", @@ -1319775,1848 +1319225,1408 @@ "admin": { "type": "boolean" }, - "pull": { + "maintain": { "type": "boolean" }, - "triage": { + "pull": { "type": "boolean" }, "push": { "type": "boolean" }, - "maintain": { + "triage": { "type": "boolean" } }, "required": [ - "admin", "pull", - "push" + "push", + "admin" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" }, - "user_view_type": { + { "type": "string", - "example": "public" + "format": "date-time" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { + "releases_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "format": "uri-template" }, - "description": { + "role_name": { "type": "string", - "example": "This your first repo!", "nullable": true }, - "fork": { - "type": "boolean" + "size": { + "type": "integer" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "ssh_url": { + "type": "string" }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "stargazers": { + "type": "integer" }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "stargazers_count": { + "type": "integer" }, - "blobs_url": { + "stargazers_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "format": "uri" }, - "branches_url": { + "statuses_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "format": "uri-template" }, - "collaborators_url": { + "subscribers_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "format": "uri" }, - "comments_url": { + "subscription_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "format": "uri" }, - "commits_url": { + "svn_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "format": "uri" }, - "compare_url": { + "tags_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "format": "uri" }, - "contents_url": { + "teams_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "format": "uri" }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "topics": { + "type": "array", + "items": { + "type": "string" + } }, - "deployments_url": { + "trees_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "format": "uri-template" }, - "downloads_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "format": "date-time" }, - "events_url": { + "url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "format": "uri" }, - "forks_url": { + "visibility": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "enum": [ + "public", + "private", + "internal" + ] }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "watchers": { + "type": "integer" }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "watchers_count": { + "type": "integer" }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "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": { + "nullable": true, + "type": "string" }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "email": { + "nullable": true, + "type": "string" }, - "issue_comment_url": { + "login": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "example": "octocat" }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "issues_url": { + "node_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "MDQ6VXNlcjE=" }, - "keys_url": { + "avatar_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "labels_url": { + "gravatar_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "languages_url": { + "url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/users/octocat" }, - "merges_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "https://github.com/octocat" }, - "notifications_url": { + "followers_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "pulls_url": { + "following_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "releases_url": { + "gists_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "ssh_url": { + "starred_url": { "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "stargazers_url": { + "subscriptions_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/users/octocat/subscriptions" }, - "subscribers_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/users/octocat/orgs" }, - "subscription_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/users/octocat/repos" }, - "tags_url": { + "events_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "teams_url": { + "received_events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://api.github.com/users/octocat/received_events" }, - "trees_url": { + "type": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "example": "User" }, - "clone_url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "example": "\"2020-07-09T00:17:55Z\"" }, - "mirror_url": { + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "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", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, - "hooks_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + "example": "https://github.com/enterprises/octo-business" }, - "svn_url": { + "website_url": { + "description": "The enterprise's website URL.", "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "nullable": true, + "format": "uri" }, - "homepage": { + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "language": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "nullable": true + "example": "Octo Business" }, - "forks_count": { - "type": "integer", - "example": 9 + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" }, - "stargazers_count": { - "type": "integer", - "example": 80 + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" }, - "watchers_count": { - "type": "integer", - "example": 80 + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", "type": "integer", - "example": 108 + "example": 1 }, - "default_branch": { - "description": "The default branch of the repository.", + "node_id": { + "description": "The global node ID of the installation.", "type": "string", - "example": "master" + "example": "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", + "example": "github" }, - "open_issues_count": { + "id": { "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true + "example": 1 }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, - "has_pages": { - "type": "boolean" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "example": true + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "issues_url": { "type": "string", - "enum": [ - "all", - "collaborators_only" - ] + "example": "https://api.github.com/orgs/github/issues" }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "pushed_at": { + "description": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", + "example": "A great organization", "nullable": true - }, + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "registry_package": { + "type": "object", + "properties": { "created_at": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", "nullable": true }, - "updated_at": { + "description": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", "nullable": true }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true + "ecosystem": { + "type": "string" }, - "template_repository": { - "nullable": true, + "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" }, - "name": { + "organizations_url": { "type": "string" }, - "full_name": { + "received_events_url": { "type": "string" }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "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", + "nullable": true, + "properties": { + "author": { + "type": "object", + "properties": { "avatar_url": { "type": "string" }, - "gravatar_id": { + "events_url": { "type": "string" }, - "url": { + "followers_url": { "type": "string" }, - "html_url": { + "following_url": { "type": "string" }, - "followers_url": { + "gists_url": { "type": "string" }, - "following_url": { + "gravatar_id": { "type": "string" }, - "gists_url": { + "html_url": { "type": "string" }, - "starred_url": { + "id": { + "type": "integer" + }, + "login": { "type": "string" }, - "subscriptions_url": { + "node_id": { "type": "string" }, "organizations_url": { "type": "string" }, + "received_events_url": { + "type": "string" + }, "repos_url": { "type": "string" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string" }, - "received_events_url": { + "subscriptions_url": { "type": "string" }, "type": { "type": "string" }, - "site_admin": { - "type": "boolean" + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" } - } - }, - "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" + }, + "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" + ] }, - "hooks_url": { - "type": "string" + "body": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] }, - "svn_url": { + "body_html": { "type": "string" }, - "homepage": { - "type": "string" + "container_metadata": { + "type": "object", + "properties": { + "labels": { + "type": "object", + "nullable": true + }, + "manifest": { + "type": "object", + "nullable": true + }, + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } }, - "language": { + "created_at": { "type": "string" }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { + "description": { "type": "string" }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { + "docker_metadata": { "type": "array", "items": { - "type": "string" + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } } }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { + "draft": { "type": "boolean" }, - "archived": { - "type": "boolean" + "html_url": { + "type": "string" }, - "disabled": { - "type": "boolean" + "id": { + "type": "integer" }, - "visibility": { + "installation_command": { "type": "string" }, - "pushed_at": { + "manifest": { "type": "string" }, - "created_at": { - "type": "string" + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } }, - "updated_at": { + "name": { "type": "string" }, - "permissions": { + "npm_metadata": { "type": "object", + "nullable": true, "properties": { - "admin": { - "type": "boolean" + "name": { + "type": "string" }, - "maintain": { - "type": "boolean" + "version": { + "type": "string" }, - "push": { - "type": "boolean" + "npm_user": { + "type": "string" }, - "triage": { + "author": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "bugs": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "dependencies": { + "type": "object" + }, + "dev_dependencies": { + "type": "object" + }, + "peer_dependencies": { + "type": "object" + }, + "optional_dependencies": { + "type": "object" + }, + "description": { + "type": "string" + }, + "dist": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "git_head": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "license": { + "type": "string" + }, + "main": { + "type": "string" + }, + "repository": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "scripts": { + "type": "object" + }, + "id": { + "type": "string" + }, + "node_version": { + "type": "string" + }, + "npm_version": { + "type": "string" + }, + "has_shrinkwrap": { "type": "boolean" }, - "pull": { + "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" + } + ], + "nullable": true + }, + "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" } } }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "action", - "release", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "release", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "release-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "release", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "release deleted event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "deleted" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "MDQ6VXNlcjU4MzIzMQ==" - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "release": { - "title": "Release", - "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", - "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", - "nullable": true - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", + "nuget_metadata": { + "type": "array", + "nullable": true, + "items": { "type": "object", - "nullable": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", + "id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "integer" + } + ], "nullable": true }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" + "name": { + "type": "string" }, - "gists_url": { - "type": "string", - "format": "uri-template" + "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" }, - "gravatar_id": { + "created_at": { "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "download_url": { + "type": "string" }, "id": { "type": "integer" }, - "login": { - "type": "string" + "md5": { + "type": "string", + "nullable": true }, "name": { "type": "string" }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { + "sha1": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "nullable": true }, - "starred_url": { + "sha256": { "type": "string", - "format": "uri-template" + "nullable": true }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "size": { + "type": "integer" }, - "type": { + "state": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "nullable": true }, - "url": { - "type": "string", - "format": "uri" + "updated_at": { + "type": "string" } }, "required": [ - "login", - "id" + "download_url", + "id", + "name", + "sha256", + "sha1", + "md5", + "content_type", + "state", + "size", + "created_at", + "updated_at" ] - }, - "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" - }, - "author": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "package_url": { + "type": "string" }, - "deleted": { + "prerelease": { "type": "boolean" }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" + "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" + } + } + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "nullable": true + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string" + } + } }, - "gists_url": { - "type": "string", - "format": "uri-template" + "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" + } + } + } }, - "gravatar_id": { + "summary": { "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { + "tag_name": { "type": "string" }, - "name": { + "target_commitish": { "type": "string" }, - "node_id": { + "target_oid": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" + "updated_at": { + "type": "string" }, - "user_view_type": { + "version": { "type": "string" } }, "required": [ - "login", - "id" + "id", + "version", + "name", + "description", + "summary", + "html_url", + "metadata", + "package_files", + "installation_command", + "package_url" ] }, - "body": { - "type": "string", - "nullable": true - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "updated_at": { - "type": "string", - "nullable": true, - "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", - "nullable": true - }, - "node_id": { - "type": "string" - }, - "prerelease": { - "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" - }, - "published_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "reactions": { - "title": "Reactions", + "registry": { "type": "object", + "nullable": true, "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" + "about_url": { + "type": "string" }, - "rocket": { - "type": "integer" + "name": { + "type": "string" }, - "total_count": { - "type": "integer" + "type": { + "type": "string" }, "url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "vendor": { + "type": "string" } - }, - "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", - "nullable": true, - "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": { + "updated_at": { "type": "string", - "nullable": true, - "format": "uri" + "nullable": true } }, "required": [ - "url", - "assets_url", - "upload_url", - "html_url", "id", - "node_id", - "tag_name", - "target_commitish", "name", - "draft", - "author", - "prerelease", - "immutable", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", "created_at", - "published_at", - "assets", - "tarball_url", "updated_at", - "zipball_url", - "body" + "owner", + "package_version", + "registry" ] }, "repository": { @@ -1322977,8 +1321987,7 @@ }, "required": [ "action", - "release", - "repository", + "registry_package", "sender" ] } @@ -1322993,7 +1322002,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -1323002,13 +1322011,13 @@ } } }, - "release-edited": { + "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": "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", + "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": [ { @@ -1323030,7 +1322039,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -1323073,68 +1322082,14 @@ "content": { "application/json": { "schema": { - "title": "release edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "updated" ] }, - "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).\"", @@ -1323297,220 +1322252,53 @@ "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", - "nullable": true - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "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" - ] - } + "created_at": { + "type": "string" }, - "assets_url": { - "type": "string", - "format": "uri" + "description": { + "nullable": true }, - "author": { - "title": "User", + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { "type": "object", - "nullable": true, "properties": { "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true + "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" @@ -1323518,46 +1322306,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" @@ -1323565,155 +1322339,457 @@ }, "required": [ "login", - "id" + "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", - "nullable": true - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "updated_at": { - "type": "string", - "nullable": true, - "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", - "nullable": true - }, - "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", - "nullable": true, - "format": "date-time" - }, - "reactions": { - "title": "Reactions", + "package_version": { "type": "object", "properties": { - "+1": { - "type": "integer" + "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" + ] }, - "-1": { - "type": "integer" + "body": { + "type": "string" }, - "confused": { - "type": "integer" + "body_html": { + "type": "string" }, - "eyes": { - "type": "integer" + "created_at": { + "type": "string" }, - "heart": { - "type": "integer" + "description": { + "type": "string" }, - "hooray": { - "type": "integer" + "docker_metadata": { + "type": "array", + "items": { + "type": "object", + "nullable": true, + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } }, - "laugh": { - "type": "integer" + "draft": { + "type": "boolean" }, - "rocket": { - "type": "integer" + "html_url": { + "type": "string" }, - "total_count": { + "id": { "type": "integer" }, - "url": { - "type": "string", - "format": "uri" + "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", + "nullable": true + }, + "name": { + "type": "string" + }, + "sha1": { + "type": "string", + "nullable": true + }, + "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": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "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" ] }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "tarball_url": { - "type": "string", - "nullable": true, - "format": "uri" + "registry": { + "type": "object", + "nullable": true }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", + "updated_at": { "type": "string" - }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, - "url": { - "type": "string", - "format": "uri" - }, - "zipball_url": { - "type": "string", - "nullable": true, - "format": "uri" } }, "required": [ - "url", - "assets_url", - "upload_url", - "html_url", "id", - "node_id", - "tag_name", - "target_commitish", "name", - "draft", - "author", - "prerelease", - "immutable", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", "created_at", - "published_at", - "assets", - "tarball_url", "updated_at", - "zipball_url", - "body" + "owner", + "package_version", + "registry" ] }, "repository": { @@ -1325074,9 +1324150,8 @@ }, "required": [ "action", - "changes", - "release", - "repository" + "registry_package", + "sender" ] } } @@ -1325090,7 +1324165,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -1325099,11 +1324174,11 @@ } } }, - "release-prereleased": { + "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 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": "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" }, @@ -1325170,13 +1324245,13 @@ "content": { "application/json": { "schema": { - "title": "release prereleased event", + "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "prereleased" + "created" ] }, "enterprise": { @@ -1325345,28 +1324420,6 @@ "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", @@ -1325374,22 +1324427,6 @@ "title": "Release Asset", "description": "Data related to a release.", "type": "object", - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ], - "nullable": true, "properties": { "browser_download_url": { "type": "string", @@ -1325441,10 +1324478,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1325527,13 +1324560,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": { @@ -1325544,10 +1324596,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1325633,7 +1324681,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": "string", @@ -1325644,6 +1324696,11 @@ "nullable": true, "format": "date-time" }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1325672,10 +1324729,7 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean", - "enum": [ - true - ] + "type": "boolean" }, "published_at": { "type": "string", @@ -1325685,18 +1324739,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1325729,7 +1324771,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.", @@ -1325748,11 +1324802,6 @@ "type": "string", "format": "uri-template" }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, "url": { "type": "string", "format": "uri" @@ -1325762,7 +1324811,29 @@ "nullable": true, "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", @@ -1327123,7 +1326194,8 @@ "required": [ "action", "release", - "repository" + "repository", + "sender" ] } } @@ -1327146,11 +1326218,11 @@ } } }, - "release-published": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "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" }, @@ -1327217,13 +1326289,13 @@ "content": { "application/json": { "schema": { - "title": "release published event", + "title": "release deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "deleted" ] }, "enterprise": { @@ -1327392,28 +1326464,6 @@ "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", @@ -1327421,22 +1326471,6 @@ "title": "Release Asset", "description": "Data related to a release.", "type": "object", - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "content_type", - "size", - "digest", - "download_count", - "created_at", - "updated_at" - ], - "nullable": true, "properties": { "browser_download_url": { "type": "string", @@ -1327488,10 +1326522,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1327574,13 +1326604,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": { @@ -1327591,10 +1326640,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1327680,7 +1326725,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": "string", @@ -1327691,6 +1326740,11 @@ "nullable": true, "format": "date-time" }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1327729,18 +1326783,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1327773,7 +1326815,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.", @@ -1327788,11 +1326842,6 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, "upload_url": { "type": "string", "format": "uri-template" @@ -1327806,7 +1326855,29 @@ "nullable": true, "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", @@ -1329167,7 +1328238,8 @@ "required": [ "action", "release", - "repository" + "repository", + "sender" ] } } @@ -1329190,11 +1328262,11 @@ } } }, - "release-released": { + "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 published, or a pre-release was changed to a release.", - "operationId": "release/released", + "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" }, @@ -1329261,15 +1328333,68 @@ "content": { "application/json": { "schema": { - "title": "release released event", + "title": "release edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "released" + "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).\"", @@ -1331209,6 +1330334,7 @@ }, "required": [ "action", + "changes", "release", "repository" ] @@ -1331233,11 +1330359,11 @@ } } }, - "release-unpublished": { + "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 or pre-release was unpublished.", - "operationId": "release/unpublished", + "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" }, @@ -1331304,13 +1330430,13 @@ "content": { "application/json": { "schema": { - "title": "release unpublished event", + "title": "release prereleased event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unpublished" + "prereleased" ] }, "enterprise": { @@ -1331488,10 +1330614,10 @@ "draft", "html_url", "id", + "immutable", "name", "node_id", "prerelease", - "immutable", "published_at", "tag_name", "tarball_url", @@ -1331516,9 +1330642,9 @@ "name", "label", "state", + "digest", "content_type", "size", - "digest", "download_count", "created_at", "updated_at" @@ -1331806,7 +1330932,10 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" + "type": "boolean", + "enum": [ + true + ] }, "published_at": { "type": "string", @@ -1331875,15 +1331004,15 @@ "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", "nullable": true, "format": "date-time" }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, "url": { "type": "string", "format": "uri" @@ -1333277,13 +1332406,13 @@ } } }, - "repository-advisory-published": { + "release-published": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A 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, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1333305,7 +1332434,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -1333348,7 +1332477,7 @@ "content": { "application/json": { "schema": { - "title": "Repository advisory published event", + "title": "release published event", "type": "object", "properties": { "action": { @@ -1333519,6 +1332648,426 @@ "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", + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], + "nullable": true, + "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", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "body": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": "string", + "nullable": true, + "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.", @@ -1334750,1584 +1334299,6 @@ "updated_at" ] }, - "repository_advisory": { - "description": "A repository security advisory.", - "type": "object", - "properties": { - "ghsa_id": { - "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true - }, - "cve_id": { - "type": "string", - "description": "The Common Vulnerabilities and Exposures (CVE) ID.", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL for the advisory.", - "readOnly": true - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535, - "nullable": true - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "nullable": true, - "enum": [ - "critical", - "high", - "medium", - "low" - ] - }, - "author": { - "readOnly": true, - "nullable": true, - "description": "The author of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "publisher": { - "readOnly": true, - "nullable": true, - "description": "The publisher of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "identifiers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } - }, - "required": [ - "type", - "value" - ] - }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "published_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "closed_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "withdrawn_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "submission": { - "type": "object", - "nullable": true, - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true - } - }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": "array", - "nullable": true, - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": "object", - "nullable": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "nullable": true - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "The range of the package versions affected by the vulnerability.", - "nullable": true - }, - "patched_versions": { - "type": "string", - "description": "The package version(s) that resolve the vulnerability.", - "nullable": true - }, - "vulnerable_functions": { - "type": "array", - "description": "The functions in the package that are affected.", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" - ], - "additionalProperties": false - } - }, - "cvss": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS vector.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_severities": { - "type": "object", - "nullable": true, - "properties": { - "cvss_v3": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 3 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 4 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "cwes": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - }, - "readOnly": true - }, - "cwe_ids": { - "type": "array", - "description": "A list of only the CWE IDs.", - "nullable": true, - "items": { - "type": "string" - } - }, - "credits": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - } - } - }, - "credits_detailed": { - "type": "array", - "nullable": true, - "items": { - "description": "A credit given to a user for a repository security advisory.", - "type": "object", - "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" - ] - } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false - }, - "readOnly": true - }, - "collaborating_users": { - "type": "array", - "description": "A list of users that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "collaborating_teams": { - "type": "array", - "description": "A list of teams that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "access_source": { - "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", - "type": "string", - "enum": [ - "direct", - "organization", - "enterprise" - ], - "example": "direct" - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "private_fork": { - "readOnly": true, - "nullable": true, - "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", - "allOf": [ - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the 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" - ] - } - ] - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cvss", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ], - "additionalProperties": false - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -1336455,8 +1334426,8 @@ }, "required": [ "action", - "repository", - "repository_advisory" + "release", + "repository" ] } } @@ -1336470,7 +1334441,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -1336479,13 +1334450,13 @@ } } }, - "repository-advisory-reported": { + "release-released": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A private vulnerability report was submitted.", - "operationId": "repository-advisory/reported", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1336507,7 +1334478,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -1336550,13 +1334521,13 @@ "content": { "application/json": { "schema": { - "title": "Repository advisory reported event", + "title": "release released event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reported" + "released" ] }, "enterprise": { @@ -1336721,6 +1334692,425 @@ "description" ] }, + "release": { + "title": "Release", + "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "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", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "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" + }, + "author": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "updated_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "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" + ] + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string" + }, + "tarball_url": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "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.", @@ -1337952,1600 +1336342,22 @@ "updated_at" ] }, - "repository_advisory": { - "description": "A repository security advisory.", + "sender": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "ghsa_id": { - "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true + "name": { + "nullable": true, + "type": "string" }, - "cve_id": { - "type": "string", - "description": "The Common Vulnerabilities and Exposures (CVE) ID.", - "nullable": true + "email": { + "nullable": true, + "type": "string" }, - "url": { + "login": { "type": "string", - "format": "uri", - "description": "The API URL for the advisory.", - "readOnly": true - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535, - "nullable": true - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "nullable": true, - "enum": [ - "critical", - "high", - "medium", - "low" - ] - }, - "author": { - "readOnly": true, - "nullable": true, - "description": "The author of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "publisher": { - "readOnly": true, - "nullable": true, - "description": "The publisher of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "identifiers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } - }, - "required": [ - "type", - "value" - ] - }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "published_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "closed_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "withdrawn_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "submission": { - "type": "object", - "nullable": true, - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true - } - }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": "array", - "nullable": true, - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": "object", - "nullable": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "nullable": true - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "The range of the package versions affected by the vulnerability.", - "nullable": true - }, - "patched_versions": { - "type": "string", - "description": "The package version(s) that resolve the vulnerability.", - "nullable": true - }, - "vulnerable_functions": { - "type": "array", - "description": "The functions in the package that are affected.", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" - ], - "additionalProperties": false - } - }, - "cvss": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS vector.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_severities": { - "type": "object", - "nullable": true, - "properties": { - "cvss_v3": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 3 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 4 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "cwes": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - }, - "readOnly": true - }, - "cwe_ids": { - "type": "array", - "description": "A list of only the CWE IDs.", - "nullable": true, - "items": { - "type": "string" - } - }, - "credits": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - } - } - }, - "credits_detailed": { - "type": "array", - "nullable": true, - "items": { - "description": "A credit given to a user for a repository security advisory.", - "type": "object", - "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" - ] - } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false - }, - "readOnly": true - }, - "collaborating_users": { - "type": "array", - "description": "A list of users that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "collaborating_teams": { - "type": "array", - "description": "A list of teams that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "access_source": { - "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", - "type": "string", - "enum": [ - "direct", - "organization", - "enterprise" - ], - "example": "direct" - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "private_fork": { - "readOnly": true, - "nullable": true, - "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", - "allOf": [ - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the 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" - ] - } - ] - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cvss", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ], - "additionalProperties": false - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" + "example": "octocat" }, "id": { "type": "integer", @@ -1339657,8 +1336469,8 @@ }, "required": [ "action", - "repository", - "repository_advisory" + "release", + "repository" ] } } @@ -1339672,7 +1336484,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -1339681,13 +1336493,13 @@ } } }, - "repository-archived": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was archived.", - "operationId": "repository/archived", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1339709,7 +1336521,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "release", "schema": { "type": "string" } @@ -1339752,13 +1336564,13 @@ "content": { "application/json": { "schema": { - "title": "repository archived event", + "title": "release unpublished event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "archived" + "unpublished" ] }, "enterprise": { @@ -1339923,6 +1336735,426 @@ "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", + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], + "nullable": true, + "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", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "body": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": "string", + "nullable": true, + "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.", @@ -1341281,8 +1338513,8 @@ }, "required": [ "action", - "repository", - "sender" + "release", + "repository" ] } } @@ -1341296,9 +1338528,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -1341306,13 +1338537,13 @@ } } }, - "repository-created": { + "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was created.", - "operationId": "repository/created", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -1341334,7 +1338565,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_advisory", "schema": { "type": "string" } @@ -1341377,13 +1338608,13 @@ "content": { "application/json": { "schema": { - "title": "repository created event", + "title": "Repository advisory published event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "published" ] }, "enterprise": { @@ -1342779,14 +1340010,1592 @@ "updated_at" ] }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", + "repository_advisory": { + "description": "A repository security advisory.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535, + "nullable": true + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "nullable": true, + "enum": [ + "critical", + "high", + "medium", + "low" + ] + }, + "author": { + "readOnly": true, + "nullable": true, + "description": "The author of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "publisher": { + "readOnly": true, + "nullable": true, + "description": "The publisher of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "closed_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "withdrawn_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "submission": { + "type": "object", + "nullable": true, + "readOnly": true, + "properties": { + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true + } + }, + "required": [ + "accepted" + ] + }, + "vulnerabilities": { + "type": "array", + "nullable": true, + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "patched_versions": { + "type": "string", + "description": "The package version(s) that resolve the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected.", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS vector.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "cwes": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": "array", + "description": "A list of only the CWE IDs.", + "nullable": true, + "items": { + "type": "string" + } + }, + "credits": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + } + } + }, + "credits_detailed": { + "type": "array", + "nullable": true, + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "state": { + "type": "string", + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" + ] + } + }, + "required": [ + "user", + "type", + "state" + ], + "additionalProperties": false + }, + "readOnly": true + }, + "collaborating_users": { + "type": "array", + "description": "A list of users that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "collaborating_teams": { + "type": "array", + "description": "A list of teams that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "access_source": { + "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", + "type": "string", + "enum": [ + "direct", + "organization", + "enterprise" + ], + "example": "direct" + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + } + }, + "private_fork": { + "readOnly": true, + "nullable": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the 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" + ] + } + ] + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cvss", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ], + "additionalProperties": false + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, "email": { "nullable": true, @@ -1342907,7 +1341716,7 @@ "required": [ "action", "repository", - "sender" + "repository_advisory" ] } } @@ -1342921,9 +1341730,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -1342931,13 +1341739,13 @@ } } }, - "repository-deleted": { + "repository-advisory-reported": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", - "operationId": "repository/deleted", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -1342959,7 +1341767,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_advisory", "schema": { "type": "string" } @@ -1343002,13 +1341810,13 @@ "content": { "application/json": { "schema": { - "title": "repository deleted event", + "title": "Repository advisory reported event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "reported" ] }, "enterprise": { @@ -1344404,151 +1343212,1728 @@ "updated_at" ] }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", + "repository_advisory": { + "description": "A repository security advisory.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { + "ghsa_id": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "description": "The GitHub Security Advisory ID.", + "readOnly": true }, - "gravatar_id": { + "cve_id": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", "nullable": true }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "description": "The API URL for the advisory.", + "readOnly": true }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat" + "description": "The URL for the advisory.", + "readOnly": true }, - "followers_url": { + "summary": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "description": "A short summary of the advisory.", + "maxLength": 1024 }, - "following_url": { + "description": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535, + "nullable": true }, - "gists_url": { + "severity": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "description": "The severity of the advisory.", + "nullable": true, + "enum": [ + "critical", + "high", + "medium", + "low" + ] }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "author": { + "readOnly": true, + "nullable": true, + "description": "The author of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "publisher": { + "readOnly": true, + "nullable": true, + "description": "The publisher of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true }, - "repos_url": { + "state": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" + ] }, - "events_url": { + "created_at": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true, + "nullable": true }, - "received_events_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true, + "nullable": true }, - "type": { + "published_at": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true, + "nullable": true }, - "starred_at": { + "closed_at": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true, + "nullable": true }, - "user_view_type": { + "withdrawn_at": { "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "action", - "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", + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "submission": { + "type": "object", + "nullable": true, + "readOnly": true, + "properties": { + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true + } + }, + "required": [ + "accepted" + ] + }, + "vulnerabilities": { + "type": "array", + "nullable": true, + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "patched_versions": { + "type": "string", + "description": "The package version(s) that resolve the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected.", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS vector.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "cwes": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": "array", + "description": "A list of only the CWE IDs.", + "nullable": true, + "items": { + "type": "string" + } + }, + "credits": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + } + } + }, + "credits_detailed": { + "type": "array", + "nullable": true, + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "state": { + "type": "string", + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" + ] + } + }, + "required": [ + "user", + "type", + "state" + ], + "additionalProperties": false + }, + "readOnly": true + }, + "collaborating_users": { + "type": "array", + "description": "A list of users that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "collaborating_teams": { + "type": "array", + "description": "A list of teams that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "access_source": { + "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", + "type": "string", + "enum": [ + "direct", + "organization", + "enterprise" + ], + "example": "direct" + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + } + }, + "private_fork": { + "readOnly": true, + "nullable": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the 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" + ] + } + ] + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cvss", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ], + "additionalProperties": false + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "repository_advisory" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -1344556,12 +1344941,13 @@ } } }, - "repository-dispatch-sample.collected": { + "repository-archived": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was archived.", + "operationId": "repository/archived", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1344583,7 +1344969,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_dispatch", + "example": "repository", "schema": { "type": "string" } @@ -1344626,21 +1345012,14 @@ "content": { "application/json": { "schema": { - "title": "repository_dispatch event", + "title": "repository archived event", "type": "object", "properties": { "action": { "type": "string", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." - }, - "branch": { - "type": "string" - }, - "client_payload": { - "type": "object", - "nullable": true, - "additionalProperties": true, - "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + "enum": [ + "archived" + ] }, "enterprise": { "title": "Enterprise", @@ -1346162,11 +1346541,8 @@ }, "required": [ "action", - "branch", - "client_payload", "repository", - "sender", - "installation" + "sender" ] } } @@ -1346180,18 +1346556,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "repository-created": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The topics, default branch, description, or homepage of a repository was changed.", - "operationId": "repository/edited", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -1346258,67 +1346637,15 @@ "content": { "application/json": { "schema": { - "title": "repository edited event", + "title": "repository created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "created" ] }, - "changes": { - "type": "object", - "properties": { - "default_branch": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "description": { - "type": "object", - "properties": { - "from": { - "type": "string", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "homepage": { - "type": "object", - "properties": { - "from": { - "type": "string", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "topics": { - "type": "object", - "properties": { - "from": { - "type": "array", - "nullable": true, - "items": { - "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).\"", @@ -1347839,7 +1348166,6 @@ }, "required": [ "action", - "changes", "repository", "sender" ] @@ -1347865,12 +1348191,13 @@ } } }, - "repository-import": { + "repository-deleted": { "post": { - "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", - "operationId": "repository-import", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1347892,7 +1348219,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_import", + "example": "repository", "schema": { "type": "string" } @@ -1347935,9 +1348262,15 @@ "content": { "application/json": { "schema": { - "title": "repository_import event", + "title": "repository deleted event", "type": "object", "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, "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).\"", @@ -1349454,18 +1349787,10 @@ "type", "url" ] - }, - "status": { - "type": "string", - "enum": [ - "success", - "cancelled", - "failure" - ] } }, "required": [ - "status", + "action", "repository", "sender" ] @@ -1349481,21 +1349806,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-privatized": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -1349517,7 +1349843,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_dispatch", "schema": { "type": "string" } @@ -1349560,14 +1349886,21 @@ "content": { "application/json": { "schema": { - "title": "repository privatized event", + "title": "repository_dispatch event", "type": "object", "properties": { "action": { "type": "string", - "enum": [ - "privatized" - ] + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, + "branch": { + "type": "string" + }, + "client_payload": { + "type": "object", + "nullable": true, + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "title": "Enterprise", @@ -1351089,8 +1351422,11 @@ }, "required": [ "action", + "branch", + "client_payload", "repository", - "sender" + "sender", + "installation" ] } } @@ -1351104,21 +1351440,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "repository-publicized": { + "repository-edited": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -1351185,15 +1351518,67 @@ "content": { "application/json": { "schema": { - "title": "repository publicized event", + "title": "repository edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicized" + "edited" ] }, + "changes": { + "type": "object", + "properties": { + "default_branch": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "description": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "homepage": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "topics": { + "type": "object", + "properties": { + "from": { + "type": "array", + "nullable": true, + "items": { + "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).\"", @@ -1352714,6 +1353099,7 @@ }, "required": [ "action", + "changes", "repository", "sender" ] @@ -1352739,13 +1353125,12 @@ } } }, - "repository-renamed": { + "repository-import": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -1352767,7 +1353152,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_import", "schema": { "type": "string" } @@ -1352810,42 +1353195,9 @@ "content": { "application/json": { "schema": { - "title": "repository renamed event", + "title": "repository_import event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "renamed" - ] - }, - "changes": { - "type": "object", - "properties": { - "repository": { - "type": "object", - "properties": { - "name": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "name" - ] - } - }, - "required": [ - "repository" - ] - }, "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).\"", @@ -1354362,11 +1354714,18 @@ "type", "url" ] + }, + "status": { + "type": "string", + "enum": [ + "success", + "cancelled", + "failure" + ] } }, "required": [ - "action", - "changes", + "status", "repository", "sender" ] @@ -1354382,23 +1354741,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_import", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-ruleset-created": { + "repository-privatized": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1354420,7 +1354777,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -1354463,13 +1354820,13 @@ "content": { "application/json": { "schema": { - "title": "repository ruleset created event", + "title": "repository privatized event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "privatized" ] }, "enterprise": { @@ -1355865,1338 +1356222,6 @@ "updated_at" ] }, - "repository_ruleset": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": "integer", - "nullable": true, - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey", - "User" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", - "enum": [ - "always", - "pull_request", - "exempt" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never", - "exempt" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": "object", - "nullable": true, - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "nullable": true, - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ] - }, - "rules": { - "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." - }, - "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" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -1357324,7 +1356349,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1357339,8 +1356364,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1357348,13 +1356374,13 @@ } } }, - "repository-ruleset-deleted": { + "repository-publicized": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1357376,7 +1356402,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -1357419,13 +1356445,13 @@ "content": { "application/json": { "schema": { - "title": "repository ruleset deleted event", + "title": "repository publicized event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "publicized" ] }, "enterprise": { @@ -1358821,1338 +1357847,6 @@ "updated_at" ] }, - "repository_ruleset": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": "integer", - "nullable": true, - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey", - "User" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", - "enum": [ - "always", - "pull_request", - "exempt" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never", - "exempt" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": "object", - "nullable": true, - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "nullable": true, - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ] - }, - "rules": { - "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." - }, - "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" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -1360280,7 +1357974,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1360295,8 +1357989,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1360304,13 +1357999,13 @@ } } }, - "repository-ruleset-edited": { + "repository-renamed": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1360332,7 +1358027,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -1360375,13 +1358070,1666 @@ "content": { "application/json": { "schema": { - "title": "repository ruleset edited event", + "title": "repository renamed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "renamed" + ] + }, + "changes": { + "type": "object", + "properties": { + "repository": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "repository" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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-ruleset-created": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "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_ruleset", + "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 ruleset created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" ] }, "enterprise": { @@ -1362421,6 +1361769,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." @@ -1363109,2959 +1362500,12522 @@ } } }, - "changes": { + "sender": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { "name": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } + "nullable": true, + "type": "string" }, - "enforcement": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } + "email": { + "nullable": true, + "type": "string" }, - "conditions": { - "type": "object", - "properties": { - "added": { - "type": "array", - "items": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "deleted": { - "type": "array", - "items": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "updated": { - "type": "array", - "items": { - "type": "object", - "properties": { - "condition": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - "changes": { - "type": "object", - "properties": { - "condition_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "target": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "include": { - "type": "object", - "properties": { - "from": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "exclude": { - "type": "object", - "properties": { - "from": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - } - } - } + "login": { + "type": "string", + "example": "octocat" }, - "rules": { - "type": "object", - "properties": { - "added": { - "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." - }, - "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" - ] + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-ruleset-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "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_ruleset", + "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 ruleset deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "repository_ruleset": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": "integer", + "nullable": true, + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "User" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", + "enum": [ + "always", + "pull_request", + "exempt" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never", + "exempt" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": "object", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" } } - }, - { - "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" - ] + } + } + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } } - }, - "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": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] } - }, - { - "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" - ] + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } } - } - }, - { - "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" - ] + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } }, - "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": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } } - }, - "required": [ - "operator", - "pattern" - ] + } } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] } + ] + } + ] + } + ] + }, + "rules": { + "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" + ] }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", + "parameters": { "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" - ] + "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" + ] }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "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": [ - "committer_email_pattern" + "ALLGREEN", + "HEADGREEN" ] }, - "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": { + "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": [ - "branch_name_pattern" + "MERGE", + "SQUASH", + "REBASE" ] }, - "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" - ] + "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" + ] }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", + "parameters": { "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" - ] + "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" + ] }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] + "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" + ] + } }, - "parameters": { + "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": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { + "allowed_actors": { "type": "array", - "description": "Workflows that must pass for this rule to pass.", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", "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": { + "id": { "type": "integer", - "description": "The ID of the repository where the workflow is defined" + "description": "ID of the actor that can dismiss reviews." }, - "sha": { + "type": { "type": "string", - "description": "The commit SHA of the workflow file to use" + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] } }, "required": [ - "path", - "repository_id" + "id", + "type" ] } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." } }, "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" + "enabled" ] }, - "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.", + "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": { - "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" - ] + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." }, - "security_alerts_threshold": { + "type": { "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).\"", + "description": "The type of the reviewer", "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" + "Team" ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" } }, "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" + "id", + "type" ] } - } - }, - "required": [ - "code_scanning_tools" - ] + }, + "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" + ] }, - { - "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.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." }, - "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." + "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." + } }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } + "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." } - } - }, - { - "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" - ] - } - } + "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" + ] }, - { - "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.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "file_path_restriction" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "max_file_path_length" + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "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" - ] + "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" + ] }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "file_extension_restriction" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "max_file_size" + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "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" - ] + "pattern": { + "type": "string", + "description": "The pattern to match with." } - } + }, + "required": [ + "operator", + "pattern" + ] } - ] - } - }, - "deleted": { - "type": "array", - "items": { - "title": "Repository Rule", + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern 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" - ] - } - } + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "update" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "deletion" + "starts_with", + "ends_with", + "contains", + "regex" ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "pattern": { "type": "string", - "enum": [ - "required_linear_history" - ] + "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" + ] }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "merge_queue" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "required_deployments" + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "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" - ] + "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" + ] }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "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": [ - "required_signatures" + "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" + ] }, - { - "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.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." }, - "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": { + "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", - "enum": [ - "merge", - "squash", - "rebase" - ] + "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" } }, - "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." - }, - "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" - ] + "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" + ] }, - { - "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.", + "parameters": { "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" + "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" } }, - "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" - ] + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } } - } - }, - { - "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" - ] - } - } + "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" + ] }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." }, - "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" - ] + "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" + ] }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", + "parameters": { "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" - ] + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } } - } - }, - { - "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" - ] - } - } + "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" + ] }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", + "parameters": { "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" - ] + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 } - } - }, - { - "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" - ] - } - } + "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" + ] }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "parameters": { "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" - ] + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } } - } - }, - { - "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" - ] - } - } + "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" + ] }, - { - "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.", + "parameters": { "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." - } - } + "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 } - } - }, - { - "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" - ] + "max_file_size" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-ruleset-edited": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "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_ruleset", + "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 ruleset edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "repository_ruleset": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": "integer", + "nullable": true, + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "User" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", + "enum": [ + "always", + "pull_request", + "exempt" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never", + "exempt" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": "object", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" } } - }, - { - "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" + } + } + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "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 + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } } - }, - "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": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "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 + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } } - }, - "required": [ - "max_file_size" - ] - } + } + }, + "required": [ + "repository_id" + ] } - } - ] + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + } + ] + } + ] + } + ] + }, + "rules": { + "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" + ] + }, + "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" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "changes": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "enforcement": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "conditions": { + "type": "object", + "properties": { + "added": { + "type": "array", + "items": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "deleted": { + "type": "array", + "items": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "condition": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + "changes": { + "type": "object", + "properties": { + "condition_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "target": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "include": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "exclude": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "rules": { + "type": "object", + "properties": { + "added": { + "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" + ] + }, + "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" + ] + }, + "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" + ] + } + } + } + ] + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "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" + ] + }, + "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" + ] + } + } + } + ] + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", + "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 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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + } + } + }, + "required": [ + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } } }, - "updated": { + "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": "object", - "properties": { - "rule": { - "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." - }, - "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" - ] - } - } - } - ] - }, - "changes": { - "type": "object", - "properties": { - "configuration": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "rule_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "pattern": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - } - } - } + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] }, "sender": { "title": "Simple User", @@ -1366190,7 +1375144,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1366205,8 +1375159,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1366214,13 +1375169,13 @@ } } }, - "repository-transferred": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to 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" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1366242,7 +1375197,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -1366285,200 +1375240,181 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "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": { + "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", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "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", @@ -1368000,7 +1376936,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1368016,23 +1376952,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": [ { @@ -1368054,7 +1376988,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -1368097,15 +1377031,191 @@ "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", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "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).\"", @@ -1369626,6 +1378736,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1369641,21 +1378752,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" }, @@ -1369722,13 +1378831,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": { @@ -1371442,11 +1380551,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" }, @@ -1371513,13 +1380622,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": { @@ -1371530,9 +1380639,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1371552,10 +1380658,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1371651,9 +1380753,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1371693,7 +1380792,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1373214,280 +1382314,1022 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "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_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "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 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" - }, - "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 reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": "string", - "nullable": true, - "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": [ + "action", + "alert", + "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_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "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 assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "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, + "nullable": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "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": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "description": "The slug identifier for the provider of the secret that was detected.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true + }, + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true + }, + "closure_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1375010,8 +1384852,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1375025,21 +1384866,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": [ { @@ -1375061,7 +1384903,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1375104,179 +1384946,797 @@ "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": { + "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, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "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": "string", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "description": "The slug identifier for the provider of the secret that was detected.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "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" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fix_reason": { - "type": "string" + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "fixed_in": { - "type": "string" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "ghsa_id": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "id": { - "type": "integer" + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "node_id": { - "type": "string" + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true }, - "number": { - "type": "integer" + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true }, - "severity": { - "type": "string" + "closure_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "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" + ] + } } } }, @@ -1376801,8 +1387261,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1376816,21 +1387275,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": [ { @@ -1376852,7 +1387312,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "secret_scanning_alert_location", "schema": { "type": "string" } @@ -1376895,13 +1387355,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": { @@ -1377664,200 +1388124,30 @@ "url" ], "nullable": true - } - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" + "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" + ] + } } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] + } }, "installation": { "title": "Simple Installation", @@ -1377880,6 +1388170,368 @@ "node_id" ] }, + "location": { + "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.", + "example": "commit" + }, + "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", + "example": "/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", + "example": "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", + "example": "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.", + "example": "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", + "example": "/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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "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.", @@ -1379310,10 +1389962,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" + } + } } } } @@ -1379325,8 +1390152,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1379335,11 +1390163,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" }, @@ -1379406,13 +1390234,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": { @@ -1380175,6 +1391003,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1381711,7 +1392561,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -1381722,13 +1392571,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": [ { @@ -1381750,7 +1392599,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert_location", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1381793,13 +1392642,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": { @@ -1382562,9 +1393411,99 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1382586,368 +1393525,6 @@ "node_id" ] }, - "location": { - "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.", - "example": "commit" - }, - "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", - "example": "/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", - "example": "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", - "example": "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.", - "example": "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", - "example": "/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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - }, "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.", @@ -1384378,185 +1394955,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" - } - } } } } @@ -1384567,10 +1394969,8 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1385419,6 +1395819,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1387806,6 +1398228,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1390193,6 +1400637,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1392580,6 +1403046,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1395091,6 +1405579,28 @@ "url" ], "nullable": true + }, + "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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 41c13daf2e..f620545da4 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1030,7 +1030,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &697 + - &699 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -14098,7 +14098,7 @@ paths: properties: action: type: string - discussion: &793 + discussion: &795 title: Discussion description: A Discussion in a repository. type: object @@ -14843,7 +14843,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &708 + sub_issues_summary: &710 title: Sub-issues Summary type: object properties: @@ -14970,7 +14970,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &709 + issue_dependencies_summary: &711 title: Issue Dependencies Summary type: object properties: @@ -16445,7 +16445,7 @@ paths: url: type: string format: uri - user: &717 + user: &719 title: Public User description: Public User type: object @@ -22311,7 +22311,7 @@ paths: parameters: - *78 - *124 - - &769 + - &771 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 @@ -22423,7 +22423,7 @@ paths: - *124 - *125 - *126 - - &770 + - &772 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -22431,7 +22431,7 @@ paths: schema: type: string - *129 - - &771 + - &773 name: sku description: The SKU to query for usage. in: query @@ -29944,12 +29944,12 @@ paths: required: - subject_digests examples: - default: &750 + default: &752 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &751 + withPredicateType: &753 value: subject_digests: - sha256:abc123 @@ -30007,7 +30007,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &752 + default: &754 value: attestations_subject_digests: - sha256:abc: @@ -42043,7 +42043,7 @@ paths: parameters: - *78 - *269 - - &733 + - &735 name: repo_name description: repo_name parameter in: path @@ -43084,7 +43084,7 @@ paths: - nuget - container - *78 - - &734 + - &736 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -43125,7 +43125,7 @@ paths: default: *276 '403': *29 '401': *25 - '400': &736 + '400': &738 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -45222,7 +45222,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &824 + properties: &826 id: type: number description: The unique identifier of the status update. @@ -45270,7 +45270,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &825 + required: &827 - id - node_id - created_at @@ -46088,7 +46088,7 @@ paths: - updated_at - project_url examples: - default: &756 + default: &758 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46265,7 +46265,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &757 + items: &759 type: object properties: name: @@ -46302,7 +46302,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &758 + iteration_configuration: &760 type: object description: The configuration for iteration fields. properties: @@ -46352,7 +46352,7 @@ paths: value: name: Due date data_type: date - single_select_field: &759 + single_select_field: &761 summary: Create a single select field value: name: Priority @@ -46379,7 +46379,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &760 + iteration_field: &762 summary: Create an iteration field value: name: Sprint @@ -46405,7 +46405,7 @@ paths: application/json: schema: *297 examples: - text_field: &761 + text_field: &763 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -46414,7 +46414,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: &762 + number_field: &764 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -46423,7 +46423,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: &763 + date_field: &765 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -46432,7 +46432,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: &764 + single_select_field: &766 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46466,7 +46466,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &765 + iteration_field: &767 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -46512,7 +46512,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *293 - - &766 + - &768 name: field_id description: The unique identifier of the field. in: path @@ -46527,7 +46527,7 @@ paths: application/json: schema: *297 examples: - default: &767 + default: &769 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47724,7 +47724,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &747 + schema: &749 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -47901,7 +47901,7 @@ paths: parameters: - *293 - *78 - - &768 + - &770 name: view_number description: The number that identifies the project view. in: path @@ -50357,6 +50357,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 @@ -51950,6 +51987,29 @@ paths: required: false schema: type: boolean + - &675 + 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 + - &676 + 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 @@ -51976,14 +52036,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &675 + state: &677 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: &676 + resolution: &678 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -52100,8 +52160,8 @@ paths: pull request. ' - oneOf: &677 - - &679 + oneOf: &679 + - &681 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -52159,7 +52219,7 @@ paths: - blob_url - commit_sha - commit_url - - &680 + - &682 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. @@ -52214,7 +52274,7 @@ paths: - page_url - commit_sha - commit_url - - &681 + - &683 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -52234,7 +52294,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &682 + - &684 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -52254,7 +52314,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &683 + - &685 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -52274,7 +52334,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &684 + - &686 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -52288,7 +52348,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &685 + - &687 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -52302,7 +52362,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &686 + - &688 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -52316,7 +52376,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &687 + - &689 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. @@ -52336,7 +52396,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &688 + - &690 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. @@ -52356,7 +52416,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &689 + - &691 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. @@ -52376,7 +52436,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &690 + - &692 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. @@ -52396,7 +52456,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &691 + - &693 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. @@ -52915,7 +52975,7 @@ paths: application/json: schema: type: array - items: &695 + items: &697 description: A repository security advisory. type: object properties: @@ -53206,7 +53266,7 @@ paths: - private_fork additionalProperties: false examples: - default: &696 + default: &698 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -55059,7 +55119,7 @@ paths: application/json: schema: type: array - items: &711 + items: &713 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 @@ -55178,7 +55238,7 @@ paths: - type - url examples: - default: &712 + default: &714 value: - login: octocat id: 1 @@ -55264,7 +55324,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &713 + response-if-user-is-a-team-maintainer: &715 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -55329,7 +55389,7 @@ paths: application/json: schema: *353 examples: - response-if-users-membership-with-team-is-now-pending: &714 + response-if-users-membership-with-team-is-now-pending: &716 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -55443,7 +55503,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &715 + schema: &717 title: Team Repository description: A team's access to a repository. type: object @@ -56100,7 +56160,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: &716 + response-if-child-teams-exist: &718 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -61753,7 +61813,7 @@ paths: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &787 + properties: &789 url: type: string format: uri @@ -61838,7 +61898,7 @@ paths: nullable: true properties: *83 required: *84 - required: &788 + required: &790 - id - node_id - sha @@ -67933,7 +67993,7 @@ paths: check. type: array items: *93 - deployment: &780 + deployment: &782 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -68845,7 +68905,7 @@ paths: type: string format: date-time nullable: true - head_commit: &808 + head_commit: &810 title: Simple Commit description: A commit. type: object @@ -73571,14 +73631,14 @@ paths: type: integer machines: type: array - items: &722 + items: &724 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *477 required: *478 examples: - default: &723 + default: &725 value: total_count: 2 machines: @@ -76724,7 +76784,7 @@ paths: application/json: schema: type: array - items: &700 + items: &702 title: Status description: The status of a commit. type: object @@ -78307,7 +78367,7 @@ paths: items: type: object properties: - placeholder_id: &692 + placeholder_id: &694 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -84367,7 +84427,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &816 + last_response: &818 title: Hook Response type: object properties: @@ -85419,7 +85479,7 @@ paths: parameters: - *354 - *355 - - &745 + - &747 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -86004,7 +86064,7 @@ paths: type: array items: *556 examples: - default: &738 + default: &740 value: - id: 1 repository: @@ -101040,6 +101100,8 @@ paths: - *672 - *673 - *674 + - *675 + - *676 responses: '200': description: Response @@ -101047,7 +101109,7 @@ paths: application/json: schema: type: array - items: &678 + items: type: object properties: number: *188 @@ -101066,8 +101128,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *675 - resolution: *676 + state: *677 + resolution: *678 resolved_at: type: string format: date-time @@ -101173,7 +101235,7 @@ paths: pull request. ' - oneOf: *677 + oneOf: *679 nullable: true has_more_locations: type: boolean @@ -101346,7 +101408,176 @@ paths: description: Response content: application/json: - schema: *678 + schema: &680 + type: object + properties: + number: *188 + created_at: *189 + updated_at: + 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 + nullable: true + url: *191 + html_url: *192 + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: *677 + resolution: *678 + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + resolution_comment: + type: string + description: An optional comment to resolve an alert. + nullable: true + 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 + description: The provider of the secret that was detected. + nullable: true + provider_slug: + type: string + 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. + nullable: true + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected + secret. + nullable: true + push_protection_bypassed_by: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO + 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection + bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the detected secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple + repositories under the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert + is base64 encoded + nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: *679 + nullable: true + 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: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + closure_request_comment: + type: string + description: An optional comment from the closure request author. + nullable: true + closure_request_reviewer_comment: + type: string + description: An optional comment from the closure request reviewer. + nullable: true + closure_request_reviewer: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + metadata: &839 + 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: @@ -101373,6 +101604,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com '304': *37 '404': description: Repository is public, or secret scanning is disabled for the @@ -101410,8 +101644,8 @@ paths: schema: type: object properties: - state: *675 - resolution: *676 + state: *677 + resolution: *678 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -101455,7 +101689,7 @@ paths: description: Response content: application/json: - schema: *678 + schema: *680 examples: default: value: @@ -101500,6 +101734,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -101567,7 +101804,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &838 + items: &841 type: object properties: type: @@ -101593,8 +101830,6 @@ paths: example: commit details: oneOf: - - *679 - - *680 - *681 - *682 - *683 @@ -101606,6 +101841,8 @@ paths: - *689 - *690 - *691 + - *692 + - *693 examples: default: value: @@ -101700,14 +101937,14 @@ paths: schema: type: object properties: - reason: &693 + reason: &695 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *692 + placeholder_id: *694 required: - reason - placeholder_id @@ -101724,7 +101961,7 @@ paths: schema: type: object properties: - reason: *693 + reason: *695 expire_at: type: string format: date-time @@ -101786,7 +102023,7 @@ paths: properties: incremental_scans: type: array - items: &694 + items: &696 description: Information on a single scan performed by secret scanning on the repository type: object @@ -101817,15 +102054,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *694 + items: *696 backfill_scans: type: array - items: *694 + items: *696 custom_pattern_backfill_scans: type: array items: allOf: - - *694 + - *696 - type: object properties: pattern_name: @@ -101838,7 +102075,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *694 + items: *696 examples: default: value: @@ -101948,9 +102185,9 @@ paths: application/json: schema: type: array - items: *695 + items: *697 examples: - default: *696 + default: *698 '400': *14 '404': *6 x-github: @@ -102134,9 +102371,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: &698 + default: &700 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -102474,7 +102711,7 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: default: value: @@ -102623,15 +102860,15 @@ paths: parameters: - *354 - *355 - - *697 + - *699 responses: '200': description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: *698 + default: *700 '403': *29 '404': *6 x-github: @@ -102657,7 +102894,7 @@ paths: parameters: - *354 - *355 - - *697 + - *699 requestBody: required: true content: @@ -102816,10 +103053,10 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: *698 - add_credit: *698 + default: *700 + add_credit: *700 '403': *29 '404': *6 '422': @@ -102859,7 +103096,7 @@ paths: parameters: - *354 - *355 - - *697 + - *699 responses: '202': *39 '400': *14 @@ -102888,7 +103125,7 @@ paths: parameters: - *354 - *355 - - *697 + - *699 responses: '202': description: Response @@ -103032,7 +103269,7 @@ paths: application/json: schema: type: array - items: &699 + items: &701 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -103405,7 +103642,7 @@ paths: application/json: schema: type: array - items: *699 + items: *701 examples: default: value: @@ -103493,7 +103730,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: default: value: @@ -103587,7 +103824,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &701 + schema: &703 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -103682,7 +103919,7 @@ paths: description: Response content: application/json: - schema: *701 + schema: *703 examples: default: value: @@ -103889,7 +104126,7 @@ paths: description: Response content: application/json: - schema: &702 + schema: &704 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -103901,7 +104138,7 @@ paths: required: - names examples: - default: &703 + default: &705 value: names: - octocat @@ -103956,9 +104193,9 @@ paths: description: Response content: application/json: - schema: *702 + schema: *704 examples: - default: *703 + default: *705 '404': *6 '422': *7 x-github: @@ -103981,7 +104218,7 @@ paths: parameters: - *354 - *355 - - &704 + - &706 name: per description: The time frame to display results for. in: query @@ -104010,7 +104247,7 @@ paths: example: 128 clones: type: array - items: &705 + items: &707 title: Traffic type: object properties: @@ -104251,7 +104488,7 @@ paths: parameters: - *354 - *355 - - *704 + - *706 responses: '200': description: Response @@ -104270,7 +104507,7 @@ paths: example: 3782 views: type: array - items: *705 + items: *707 required: - uniques - count @@ -105042,7 +105279,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &706 + text_matches: &708 title: Search Result Text Matches type: array items: @@ -105204,7 +105441,7 @@ paths: enum: - author-date - committer-date - - &707 + - &709 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 @@ -105332,7 +105569,7 @@ paths: type: number node_id: type: string - text_matches: *706 + text_matches: *708 required: - sha - node_id @@ -105524,7 +105761,7 @@ paths: - interactions - created - updated - - *707 + - *709 - *17 - *19 - name: advanced_search @@ -105638,8 +105875,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -105674,7 +105911,7 @@ paths: type: string format: date-time nullable: true - text_matches: *706 + text_matches: *708 pull_request: type: object properties: @@ -105956,7 +106193,7 @@ paths: enum: - created - updated - - *707 + - *709 - *17 - *19 responses: @@ -106000,7 +106237,7 @@ paths: nullable: true score: type: number - text_matches: *706 + text_matches: *708 required: - id - node_id @@ -106085,7 +106322,7 @@ paths: - forks - help-wanted-issues - updated - - *707 + - *709 - *17 - *19 responses: @@ -106333,7 +106570,7 @@ paths: - admin - pull - push - text_matches: *706 + text_matches: *708 temp_clone_token: type: string allow_merge_commit: @@ -106633,7 +106870,7 @@ paths: type: string format: uri nullable: true - text_matches: *706 + text_matches: *708 related: type: array nullable: true @@ -106824,7 +107061,7 @@ paths: - followers - repositories - joined - - *707 + - *709 - *17 - *19 responses: @@ -106928,7 +107165,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *706 + text_matches: *708 blog: type: string nullable: true @@ -107007,7 +107244,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &710 + - &712 name: team_id description: The unique identifier of the team. in: path @@ -107048,7 +107285,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *710 + - *712 requestBody: required: true content: @@ -107148,7 +107385,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *710 + - *712 responses: '204': description: Response @@ -107177,7 +107414,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *710 + - *712 - *17 - *19 responses: @@ -107217,7 +107454,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *710 + - *712 - name: role description: Filters members returned by their role in the team. in: query @@ -107238,9 +107475,9 @@ paths: application/json: schema: type: array - items: *711 + items: *713 examples: - default: *712 + default: *714 headers: Link: *70 '404': *6 @@ -107268,7 +107505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *710 + - *712 - *74 responses: '204': @@ -107305,7 +107542,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *710 + - *712 - *74 responses: '204': @@ -107345,7 +107582,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *710 + - *712 - *74 responses: '204': @@ -107382,7 +107619,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *710 + - *712 - *74 responses: '200': @@ -107391,7 +107628,7 @@ paths: application/json: schema: *353 examples: - response-if-user-is-a-team-maintainer: *713 + response-if-user-is-a-team-maintainer: *715 '404': *6 x-github: githubCloudOnly: false @@ -107424,7 +107661,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *710 + - *712 - *74 requestBody: required: false @@ -107452,7 +107689,7 @@ paths: application/json: schema: *353 examples: - response-if-users-membership-with-team-is-now-pending: *714 + response-if-users-membership-with-team-is-now-pending: *716 '403': description: Forbidden if team synchronization is set up '422': @@ -107486,7 +107723,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *710 + - *712 - *74 responses: '204': @@ -107514,7 +107751,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *710 + - *712 - *17 - *19 responses: @@ -107556,7 +107793,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *710 + - *712 - *354 - *355 responses: @@ -107564,7 +107801,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *715 + schema: *717 examples: alternative-response-with-extra-repository-information: value: @@ -107715,7 +107952,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *710 + - *712 - *354 - *355 requestBody: @@ -107767,7 +108004,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *710 + - *712 - *354 - *355 responses: @@ -107794,7 +108031,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *710 + - *712 - *17 - *19 responses: @@ -107806,7 +108043,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: *716 + response-if-child-teams-exist: *718 headers: Link: *70 '404': *6 @@ -107839,7 +108076,7 @@ paths: application/json: schema: oneOf: - - &718 + - &720 title: Private User description: Private User type: object @@ -108042,7 +108279,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *717 + - *719 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -108195,7 +108432,7 @@ paths: description: Response content: application/json: - schema: *718 + schema: *720 examples: default: value: @@ -108593,7 +108830,7 @@ paths: type: integer secrets: type: array - items: &719 + items: &721 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -108709,7 +108946,7 @@ paths: description: Response content: application/json: - schema: *719 + schema: *721 examples: default: value: @@ -109122,7 +109359,7 @@ paths: description: Response content: application/json: - schema: &720 + schema: &722 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -109163,7 +109400,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &721 + default: &723 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -109208,9 +109445,9 @@ paths: description: Response content: application/json: - schema: *720 + schema: *722 examples: - default: *721 + default: *723 '404': *6 x-github: githubCloudOnly: false @@ -109247,9 +109484,9 @@ paths: type: integer machines: type: array - items: *722 + items: *724 examples: - default: *723 + default: *725 '304': *37 '500': *55 '401': *25 @@ -110188,7 +110425,7 @@ paths: type: array items: *275 examples: - default: &735 + default: &737 value: - id: 197 name: hello_docker @@ -110289,7 +110526,7 @@ paths: application/json: schema: type: array - items: &724 + items: &726 title: Email description: Email type: object @@ -110354,9 +110591,9 @@ paths: application/json: schema: type: array - items: *724 + items: *726 examples: - default: &737 + default: &739 value: - email: octocat@github.com verified: true @@ -110431,7 +110668,7 @@ paths: application/json: schema: type: array - items: *724 + items: *726 examples: default: value: @@ -110687,7 +110924,7 @@ paths: application/json: schema: type: array - items: &725 + items: &727 title: GPG Key description: A unique encryption key type: object @@ -110818,7 +111055,7 @@ paths: - subkeys - revoked examples: - default: &754 + default: &756 value: - id: 3 name: Octocat's GPG Key @@ -110903,9 +111140,9 @@ paths: description: Response content: application/json: - schema: *725 + schema: *727 examples: - default: &726 + default: &728 value: id: 3 name: Octocat's GPG Key @@ -110962,7 +111199,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &727 + - &729 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -110974,9 +111211,9 @@ paths: description: Response content: application/json: - schema: *725 + schema: *727 examples: - default: *726 + default: *728 '404': *6 '304': *37 '403': *29 @@ -110999,7 +111236,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *727 + - *729 responses: '204': description: Response @@ -111466,7 +111703,7 @@ paths: application/json: schema: type: array - items: &728 + items: &730 title: Key description: Key type: object @@ -111567,9 +111804,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *730 examples: - default: &729 + default: &731 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -111608,9 +111845,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *730 examples: - default: *729 + default: *731 '404': *6 '304': *37 '403': *29 @@ -111666,7 +111903,7 @@ paths: application/json: schema: type: array - items: &730 + items: &732 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -111734,7 +111971,7 @@ paths: - account - plan examples: - default: &731 + default: &733 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -111796,9 +112033,9 @@ paths: application/json: schema: type: array - items: *730 + items: *732 examples: - default: *731 + default: *733 headers: Link: *70 '304': *37 @@ -112041,7 +112278,7 @@ paths: application/json: schema: *266 examples: - default: &732 + default: &734 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -112090,7 +112327,7 @@ paths: application/json: schema: *266 examples: - default: *732 + default: *734 '403': *29 '404': *6 '422': *15 @@ -112815,7 +113052,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *269 - - *733 + - *735 responses: '204': description: Response @@ -112930,7 +113167,7 @@ paths: - docker - nuget - container - - *734 + - *736 - *19 - *17 responses: @@ -112942,8 +113179,8 @@ paths: type: array items: *275 examples: - default: *735 - '400': *736 + default: *737 + '400': *738 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112972,7 +113209,7 @@ paths: application/json: schema: *275 examples: - default: &755 + default: &757 value: id: 40201 name: octo-name @@ -113334,9 +113571,9 @@ paths: application/json: schema: type: array - items: *724 + items: *726 examples: - default: *737 + default: *739 headers: Link: *70 '304': *37 @@ -113449,7 +113686,7 @@ paths: type: array items: *82 examples: - default: &744 + default: &746 summary: Default response value: - id: 1296269 @@ -113795,7 +114032,7 @@ paths: type: array items: *556 examples: - default: *738 + default: *740 headers: Link: *70 '304': *37 @@ -113874,7 +114111,7 @@ paths: application/json: schema: type: array - items: &739 + items: &741 title: Social account description: Social media account type: object @@ -113889,7 +114126,7 @@ paths: - provider - url examples: - default: &740 + default: &742 value: - provider: twitter url: https://twitter.com/github @@ -113951,9 +114188,9 @@ paths: application/json: schema: type: array - items: *739 + items: *741 examples: - default: *740 + default: *742 '422': *15 '304': *37 '404': *6 @@ -114040,7 +114277,7 @@ paths: application/json: schema: type: array - items: &741 + items: &743 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -114060,7 +114297,7 @@ paths: - title - created_at examples: - default: &772 + default: &774 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -114124,9 +114361,9 @@ paths: description: Response content: application/json: - schema: *741 + schema: *743 examples: - default: &742 + default: &744 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -114156,7 +114393,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: - - &743 + - &745 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -114168,9 +114405,9 @@ paths: description: Response content: application/json: - schema: *741 + schema: *743 examples: - default: *742 + default: *744 '404': *6 '304': *37 '403': *29 @@ -114193,7 +114430,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: - - *743 + - *745 responses: '204': description: Response @@ -114222,7 +114459,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &773 + - &775 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 @@ -114247,11 +114484,11 @@ paths: type: array items: *82 examples: - default-response: *744 + default-response: *746 application/vnd.github.v3.star+json: schema: type: array - items: &774 + items: &776 title: Starred Repository description: Starred Repository type: object @@ -114620,10 +114857,10 @@ paths: application/json: schema: oneOf: - - *718 - - *717 + - *720 + - *719 examples: - default-response: &748 + default-response: &750 summary: Default response value: login: octocat @@ -114658,7 +114895,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &749 + response-with-git-hub-plan-information: &751 summary: Response with GitHub plan information value: login: octocat @@ -114715,7 +114952,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &746 + - &748 name: user_id description: The unique identifier of the user. in: path @@ -114781,7 +115018,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *745 + - *747 - *17 responses: '200': @@ -114816,7 +115053,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *746 + - *748 - *293 requestBody: required: true @@ -114888,7 +115125,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *747 + schema: *749 examples: table_view: summary: Response for creating a table view @@ -114940,11 +115177,11 @@ paths: application/json: schema: oneOf: - - *718 - - *717 + - *720 + - *719 examples: - default-response: *748 - response-with-git-hub-plan-information: *749 + default-response: *750 + response-with-git-hub-plan-information: *751 '404': *6 x-github: githubCloudOnly: false @@ -114994,8 +115231,8 @@ paths: required: - subject_digests examples: - default: *750 - withPredicateType: *751 + default: *752 + withPredicateType: *753 responses: '200': description: Response @@ -115048,7 +115285,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *752 + default: *754 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -115534,7 +115771,7 @@ paths: application/json: schema: *204 examples: - default: &753 + default: &755 summary: Example response for a user copilot space value: id: 42 @@ -115635,7 +115872,7 @@ paths: application/json: schema: *204 examples: - default: *753 + default: *755 '403': *29 '404': *6 x-github: @@ -115758,7 +115995,7 @@ paths: application/json: schema: *204 examples: - default: *753 + default: *755 '403': *29 '404': *6 '422': *15 @@ -116526,7 +116763,7 @@ paths: type: array items: *275 examples: - default: *735 + default: *737 '403': *29 '401': *25 x-github: @@ -116910,9 +117147,9 @@ paths: application/json: schema: type: array - items: *725 + items: *727 examples: - default: *754 + default: *756 headers: Link: *70 x-github: @@ -117140,7 +117377,7 @@ paths: - docker - nuget - container - - *734 + - *736 - *74 - *19 - *17 @@ -117153,10 +117390,10 @@ paths: type: array items: *275 examples: - default: *735 + default: *737 '403': *29 '401': *25 - '400': *736 + '400': *738 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117186,7 +117423,7 @@ paths: application/json: schema: *275 examples: - default: *755 + default: *757 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117535,7 +117772,7 @@ paths: type: array items: *297 examples: - default: *756 + default: *758 headers: Link: *70 '304': *37 @@ -117595,7 +117832,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *757 + items: *759 required: - name - data_type @@ -117611,7 +117848,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *758 + iteration_configuration: *760 required: - name - data_type @@ -117633,8 +117870,8 @@ paths: value: name: Due date data_type: date - single_select_field: *759 - iteration_field: *760 + single_select_field: *761 + iteration_field: *762 responses: '201': description: Response @@ -117642,11 +117879,11 @@ paths: application/json: schema: *297 examples: - text_field: *761 - number_field: *762 - date_field: *763 - single_select_field: *764 - iteration_field: *765 + text_field: *763 + number_field: *764 + date_field: *765 + single_select_field: *766 + iteration_field: *767 '304': *37 '403': *29 '401': *25 @@ -117668,7 +117905,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *293 - - *766 + - *768 - *74 responses: '200': @@ -117677,7 +117914,7 @@ paths: application/json: schema: *297 examples: - default: *767 + default: *769 headers: Link: *70 '304': *37 @@ -118031,7 +118268,7 @@ paths: parameters: - *293 - *74 - - *768 + - *770 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -118570,7 +118807,7 @@ paths: parameters: - *74 - *124 - - *769 + - *771 - *126 responses: '200': @@ -118669,9 +118906,9 @@ paths: - *124 - *125 - *126 - - *770 + - *772 - *129 - - *771 + - *773 responses: '200': description: Response when getting a billing usage summary @@ -118805,9 +119042,9 @@ paths: application/json: schema: type: array - items: *739 + items: *741 examples: - default: *740 + default: *742 headers: Link: *70 x-github: @@ -118837,9 +119074,9 @@ paths: application/json: schema: type: array - items: *741 + items: *743 examples: - default: *772 + default: *774 headers: Link: *70 x-github: @@ -118864,7 +119101,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *74 - - *773 + - *775 - *62 - *17 - *19 @@ -118876,11 +119113,11 @@ paths: schema: anyOf: - type: array - items: *774 + items: *776 - type: array items: *82 examples: - default-response: *744 + default-response: *746 headers: Link: *70 x-github: @@ -119039,7 +119276,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &775 + enterprise: &777 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -119097,7 +119334,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &776 + installation: &778 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -119116,7 +119353,7 @@ x-webhooks: required: - id - node_id - organization: &777 + organization: &779 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -119176,13 +119413,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &778 + repository: &780 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &810 + properties: &812 id: description: Unique identifier of the repository example: 42 @@ -119877,7 +120114,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &811 + required: &813 - archive_url - assignees_url - blobs_url @@ -120028,10 +120265,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -120107,11 +120344,11 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - rule: &779 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + rule: &781 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) @@ -120334,11 +120571,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - rule: *779 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + rule: *781 sender: *4 required: - action @@ -120521,11 +120758,11 @@ x-webhooks: - everyone required: - from - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - rule: *779 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + rule: *781 sender: *4 required: - action @@ -120609,7 +120846,7 @@ x-webhooks: type: string enum: - completed - check_run: &781 + check_run: &783 title: CheckRun description: A check performed on the code of a given code change type: object @@ -120700,7 +120937,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *780 + deployment: *782 details_url: example: https://example.com type: string @@ -120785,10 +121022,10 @@ x-webhooks: - output - app - pull_requests - installation: *776 - enterprise: *775 - organization: *777 - repository: *778 + installation: *778 + enterprise: *777 + organization: *779 + repository: *780 sender: *4 required: - check_run @@ -121179,11 +121416,11 @@ x-webhooks: type: string enum: - created - check_run: *781 - installation: *776 - enterprise: *775 - organization: *777 - repository: *778 + check_run: *783 + installation: *778 + enterprise: *777 + organization: *779 + repository: *780 sender: *4 required: - check_run @@ -121577,11 +121814,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *781 - installation: *776 - enterprise: *775 - organization: *777 - repository: *778 + check_run: *783 + installation: *778 + enterprise: *777 + organization: *779 + repository: *780 requested_action: description: The action requested by the user. type: object @@ -121984,11 +122221,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *781 - installation: *776 - enterprise: *775 - organization: *777 - repository: *778 + check_run: *783 + installation: *778 + enterprise: *777 + organization: *779 + repository: *780 sender: *4 required: - check_run @@ -122958,10 +123195,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -123660,10 +123897,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -124356,10 +124593,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -124670,20 +124907,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &782 + commit_oid: &784 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: *775 - installation: *776 - organization: *777 - ref: &783 + enterprise: *777 + installation: *778 + organization: *779 + ref: &785 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: *778 + repository: *780 sender: *4 required: - action @@ -125078,12 +125315,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *782 - enterprise: *775 - installation: *776 - organization: *777 - ref: *783 - repository: *778 + commit_oid: *784 + enterprise: *777 + installation: *778 + organization: *779 + ref: *785 + repository: *780 sender: *4 required: - action @@ -125349,12 +125586,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *782 - enterprise: *775 - installation: *776 - organization: *777 - ref: *783 - repository: *778 + commit_oid: *784 + enterprise: *777 + installation: *778 + organization: *779 + ref: *785 + repository: *780 sender: *4 required: - action @@ -125686,12 +125923,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *782 - enterprise: *775 - installation: *776 - organization: *777 - ref: *783 - repository: *778 + commit_oid: *784 + enterprise: *777 + installation: *778 + organization: *779 + ref: *785 + repository: *780 sender: *4 required: - action @@ -125965,16 +126202,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 ref: 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 nullable: true - repository: *778 + repository: *780 sender: *4 required: - action @@ -126211,12 +126448,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *782 - enterprise: *775 - installation: *776 - organization: *777 - ref: *783 - repository: *778 + commit_oid: *784 + enterprise: *777 + installation: *778 + organization: *779 + ref: *785 + repository: *780 sender: *4 required: - action @@ -126527,10 +126764,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -126785,10 +127022,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -126868,18 +127105,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *777 - pusher_type: &784 + organization: *779 + pusher_type: &786 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &785 + ref: &787 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -126889,7 +127126,7 @@ x-webhooks: enum: - tag - branch - repository: *778 + repository: *780 sender: *4 required: - ref @@ -126972,9 +127209,9 @@ x-webhooks: enum: - created definition: *305 - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 sender: *4 required: - action @@ -127059,9 +127296,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 sender: *4 required: - action @@ -127139,9 +127376,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *305 - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 sender: *4 required: - action @@ -127219,9 +127456,9 @@ x-webhooks: enum: - updated definition: *305 - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 sender: *4 required: - action @@ -127298,10 +127535,10 @@ x-webhooks: type: string enum: - updated - enterprise: *775 - installation: *776 - repository: *778 - organization: *777 + enterprise: *777 + installation: *778 + repository: *780 + organization: *779 sender: *4 new_property_values: type: array @@ -127386,18 +127623,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *775 - installation: *776 - organization: *777 - pusher_type: *784 - ref: *785 + enterprise: *777 + installation: *778 + organization: *779 + pusher_type: *786 + ref: *787 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *778 + repository: *780 sender: *4 required: - ref @@ -127478,10 +127715,10 @@ x-webhooks: enum: - assignees_changed alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127562,10 +127799,10 @@ x-webhooks: enum: - auto_dismissed alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127647,10 +127884,10 @@ x-webhooks: enum: - auto_reopened alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127732,10 +127969,10 @@ x-webhooks: enum: - created alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127815,10 +128052,10 @@ x-webhooks: enum: - dismissed alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127898,10 +128135,10 @@ x-webhooks: enum: - fixed alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127982,10 +128219,10 @@ x-webhooks: enum: - reintroduced alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -128065,10 +128302,10 @@ x-webhooks: enum: - reopened alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -128145,9 +128382,9 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - key: &786 + enterprise: *777 + installation: *778 + key: &788 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -128183,8 +128420,8 @@ x-webhooks: - verified - created_at - read_only - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -128261,11 +128498,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - key: *786 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + key: *788 + organization: *779 + repository: *780 sender: *4 required: - action @@ -128821,12 +129058,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - workflow: &792 + workflow: &794 title: Workflow type: object nullable: true @@ -129567,15 +129804,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *787 - required: *788 + properties: *789 + required: *790 nullable: true pull_requests: type: array items: *625 - repository: *778 - organization: *777 - installation: *776 + repository: *780 + organization: *779 + installation: *778 sender: *4 responses: '200': @@ -129646,7 +129883,7 @@ x-webhooks: type: string enum: - approved - approver: &789 + approver: &791 type: object properties: avatar_url: @@ -129689,11 +129926,11 @@ x-webhooks: type: string comment: type: string - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - reviewers: &790 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + reviewers: &792 type: array items: type: object @@ -129772,7 +130009,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &791 + workflow_job_run: &793 type: object properties: conclusion: @@ -130503,18 +130740,18 @@ x-webhooks: type: string enum: - rejected - approver: *789 + approver: *791 comment: type: string - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - reviewers: *790 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + reviewers: *792 sender: *4 since: type: string - workflow_job_run: *791 + workflow_job_run: *793 workflow_job_runs: type: array items: @@ -131218,13 +131455,13 @@ x-webhooks: type: string enum: - requested - enterprise: *775 + enterprise: *777 environment: type: string - installation: *776 - organization: *777 - repository: *778 - requestor: &797 + installation: *778 + organization: *779 + repository: *780 + requestor: &799 title: User type: object nullable: true @@ -133113,12 +133350,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - workflow: *792 + workflow: *794 workflow_run: title: Deployment Workflow Run type: object @@ -133798,7 +134035,7 @@ x-webhooks: type: string enum: - answered - answer: &795 + answer: &797 type: object properties: author_association: @@ -133955,11 +134192,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134086,11 +134323,11 @@ x-webhooks: - from required: - category - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134173,11 +134410,11 @@ x-webhooks: type: string enum: - closed - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134259,7 +134496,7 @@ x-webhooks: type: string enum: - created - comment: &794 + comment: &796 type: object properties: author_association: @@ -134416,11 +134653,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134503,12 +134740,12 @@ x-webhooks: type: string enum: - deleted - comment: *794 - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + comment: *796 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134603,12 +134840,12 @@ x-webhooks: - from required: - body - comment: *794 - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + comment: *796 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134692,11 +134929,11 @@ x-webhooks: type: string enum: - created - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134778,11 +135015,11 @@ x-webhooks: type: string enum: - deleted - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134882,11 +135119,11 @@ x-webhooks: type: string required: - from - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134968,10 +135205,10 @@ x-webhooks: type: string enum: - labeled - discussion: *793 - enterprise: *775 - installation: *776 - label: &796 + discussion: *795 + enterprise: *777 + installation: *778 + label: &798 title: Label type: object properties: @@ -135003,8 +135240,8 @@ x-webhooks: - color - default - description - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135087,11 +135324,11 @@ x-webhooks: type: string enum: - locked - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135173,11 +135410,11 @@ x-webhooks: type: string enum: - pinned - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135259,11 +135496,11 @@ x-webhooks: type: string enum: - reopened - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135348,16 +135585,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *793 - new_repository: *778 + new_discussion: *795 + new_repository: *780 required: - new_discussion - new_repository - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135440,10 +135677,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *793 - old_answer: *795 - organization: *777 - repository: *778 + discussion: *795 + old_answer: *797 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135525,12 +135762,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *793 - enterprise: *775 - installation: *776 - label: *796 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135613,11 +135850,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135699,11 +135936,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135776,7 +136013,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *775 + enterprise: *777 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -136436,9 +136673,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - forkee @@ -136584,9 +136821,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pages: description: The pages that were updated. type: array @@ -136623,7 +136860,7 @@ x-webhooks: - action - sha - html_url - repository: *778 + repository: *780 sender: *4 required: - pages @@ -136699,10 +136936,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories: &798 + organization: *779 + repositories: &800 description: An array of repository objects that the installation can access. type: array @@ -136728,8 +136965,8 @@ x-webhooks: - name - full_name - private - repository: *778 - requester: *797 + repository: *780 + requester: *799 sender: *4 required: - action @@ -136804,11 +137041,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories: *798 - repository: *778 + organization: *779 + repositories: *800 + repository: *780 requester: nullable: true sender: *4 @@ -136884,11 +137121,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories: *798 - repository: *778 + organization: *779 + repositories: *800 + repository: *780 requester: nullable: true sender: *4 @@ -136964,10 +137201,10 @@ x-webhooks: type: string enum: - added - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories_added: &799 + organization: *779 + repositories_added: &801 description: An array of repository objects, which were added to the installation. type: array @@ -137013,15 +137250,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *778 - repository_selection: &800 + repository: *780 + repository_selection: &802 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *797 + requester: *799 sender: *4 required: - action @@ -137100,10 +137337,10 @@ x-webhooks: type: string enum: - removed - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories_added: *799 + organization: *779 + repositories_added: *801 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -137130,9 +137367,9 @@ x-webhooks: - name - full_name - private - repository: *778 - repository_selection: *800 - requester: *797 + repository: *780 + repository_selection: *802 + requester: *799 sender: *4 required: - action @@ -137211,11 +137448,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories: *798 - repository: *778 + organization: *779 + repositories: *800 + repository: *780 requester: nullable: true sender: *4 @@ -137393,10 +137630,10 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 target_type: type: string @@ -137475,11 +137712,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories: *798 - repository: *778 + organization: *779 + repositories: *800 + repository: *780 requester: nullable: true sender: *4 @@ -137746,8 +137983,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -138536,8 +138773,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138886,8 +139123,8 @@ x-webhooks: - state - locked - assignee - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -138967,7 +139204,7 @@ x-webhooks: type: string enum: - deleted - comment: &801 + comment: &803 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -139147,8 +139384,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -139933,8 +140170,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140285,8 +140522,8 @@ x-webhooks: - state - locked - assignee - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -140366,7 +140603,7 @@ x-webhooks: type: string enum: - edited - changes: &830 + changes: &832 description: The changes to the comment. type: object properties: @@ -140378,9 +140615,9 @@ x-webhooks: type: string required: - from - comment: *801 - enterprise: *775 - installation: *776 + comment: *803 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -141168,8 +141405,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141518,8 +141755,8 @@ x-webhooks: - state - locked - assignee - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -141600,9 +141837,9 @@ x-webhooks: type: string enum: - pinned - comment: *801 - enterprise: *775 - installation: *776 + comment: *803 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -142392,8 +142629,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142744,8 +142981,8 @@ x-webhooks: - state - locked - assignee - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -142825,9 +143062,9 @@ x-webhooks: type: string enum: - unpinned - comment: *801 - enterprise: *775 - installation: *776 + comment: *803 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -143617,8 +143854,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143969,8 +144206,8 @@ x-webhooks: - state - locked - assignee - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -144059,9 +144296,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -144150,9 +144387,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -144240,9 +144477,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -144331,9 +144568,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -144413,10 +144650,10 @@ x-webhooks: type: string enum: - assigned - assignee: *797 - enterprise: *775 - installation: *776 - issue: &802 + assignee: *799 + enterprise: *777 + installation: *778 + issue: &804 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -145208,8 +145445,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -145329,8 +145566,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -145410,8 +145647,8 @@ x-webhooks: type: string enum: - closed - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -146208,8 +146445,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -146464,8 +146701,8 @@ x-webhooks: required: - state - closed_at - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -146544,8 +146781,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147333,8 +147570,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -147453,8 +147690,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -147533,8 +147770,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148344,8 +148581,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -148443,7 +148680,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &803 + milestone: &805 title: Milestone description: A collection of related issues and pull requests. type: object @@ -148581,8 +148818,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -148681,8 +148918,8 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149474,8 +149711,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -149595,9 +149832,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *796 - organization: *777 - repository: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -149677,9 +149914,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *775 - installation: *776 - issue: *802 + enterprise: *777 + installation: *778 + issue: *804 issue_field: type: object description: The issue field whose value was set or updated on the @@ -149833,8 +150070,8 @@ x-webhooks: - id required: - from - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -149914,9 +150151,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *775 - installation: *776 - issue: *802 + enterprise: *777 + installation: *778 + issue: *804 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -149997,8 +150234,8 @@ x-webhooks: nullable: true required: - id - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -150078,8 +150315,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150870,8 +151107,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -150991,9 +151228,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *796 - organization: *777 - repository: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -151073,8 +151310,8 @@ x-webhooks: type: string enum: - locked - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151889,8 +152126,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -151987,8 +152224,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -152067,8 +152304,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152877,8 +153114,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -152975,9 +153212,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *803 - organization: *777 - repository: *778 + milestone: *805 + organization: *779 + repository: *780 sender: *4 required: - action @@ -153840,8 +154077,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -154425,8 +154662,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -155210,8 +155447,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -155338,8 +155575,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -155419,9 +155656,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *775 - installation: *776 - issue: &804 + enterprise: *777 + installation: *778 + issue: &806 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -156207,8 +156444,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -156327,8 +156564,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -156407,8 +156644,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -157221,8 +157458,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -157320,8 +157557,8 @@ x-webhooks: user_view_type: type: string type: *257 - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -158190,8 +158427,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -158789,11 +159026,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *775 - installation: *776 - issue: *804 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + issue: *806 + organization: *779 + repository: *780 sender: *4 required: - action @@ -158873,12 +159110,12 @@ x-webhooks: type: string enum: - typed - enterprise: *775 - installation: *776 - issue: *802 + enterprise: *777 + installation: *778 + issue: *804 type: *257 - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -158959,7 +159196,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &833 + assignee: &835 title: User type: object nullable: true @@ -159029,11 +159266,11 @@ x-webhooks: required: - login - id - enterprise: *775 - installation: *776 - issue: *802 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + issue: *804 + organization: *779 + repository: *780 sender: *4 required: - action @@ -159112,12 +159349,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *775 - installation: *776 - issue: *802 - label: *796 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + issue: *804 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -159197,8 +159434,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -160011,8 +160248,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -160109,8 +160346,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -160190,11 +160427,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *775 - installation: *776 - issue: *804 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + issue: *806 + organization: *779 + repository: *780 sender: *4 required: - action @@ -160273,12 +160510,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *775 - installation: *776 - issue: *802 + enterprise: *777 + installation: *778 + issue: *804 type: *257 - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -160358,11 +160595,11 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - label: *796 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -160440,11 +160677,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - label: *796 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -160554,11 +160791,11 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - label: *796 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -160640,9 +160877,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *775 - installation: *776 - marketplace_purchase: &805 + enterprise: *777 + installation: *778 + marketplace_purchase: &807 title: Marketplace Purchase type: object required: @@ -160725,8 +160962,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *777 - previous_marketplace_purchase: &806 + organization: *779 + previous_marketplace_purchase: &808 title: Marketplace Purchase type: object properties: @@ -160806,7 +161043,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *778 + repository: *780 sender: *4 required: - action @@ -160886,10 +161123,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *775 - installation: *776 - marketplace_purchase: *805 - organization: *777 + enterprise: *777 + installation: *778 + marketplace_purchase: *807 + organization: *779 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -160972,7 +161209,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *778 + repository: *780 sender: *4 required: - action @@ -161054,10 +161291,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *775 - installation: *776 - marketplace_purchase: *805 - organization: *777 + enterprise: *777 + installation: *778 + marketplace_purchase: *807 + organization: *779 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161139,7 +161376,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *778 + repository: *780 sender: *4 required: - action @@ -161220,8 +161457,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 marketplace_purchase: title: Marketplace Purchase type: object @@ -161303,9 +161540,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *777 - previous_marketplace_purchase: *806 - repository: *778 + organization: *779 + previous_marketplace_purchase: *808 + repository: *780 sender: *4 required: - action @@ -161385,12 +161622,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *775 - installation: *776 - marketplace_purchase: *805 - organization: *777 - previous_marketplace_purchase: *806 - repository: *778 + enterprise: *777 + installation: *778 + marketplace_purchase: *807 + organization: *779 + previous_marketplace_purchase: *808 + repository: *780 sender: *4 required: - action @@ -161492,11 +161729,11 @@ x-webhooks: type: string required: - to - enterprise: *775 - installation: *776 - member: *797 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + member: *799 + organization: *779 + repository: *780 sender: *4 required: - action @@ -161596,11 +161833,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *775 - installation: *776 - member: *797 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + member: *799 + organization: *779 + repository: *780 sender: *4 required: - action @@ -161679,11 +161916,11 @@ x-webhooks: type: string enum: - removed - enterprise: *775 - installation: *776 - member: *797 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + member: *799 + organization: *779 + repository: *780 sender: *4 required: - action @@ -161761,11 +161998,11 @@ x-webhooks: type: string enum: - added - enterprise: *775 - installation: *776 - member: *797 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + member: *799 + organization: *779 + repository: *780 scope: description: The scope of the membership. Currently, can only be `team`. @@ -161841,7 +162078,7 @@ x-webhooks: required: - login - id - team: &807 + team: &809 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -162064,11 +162301,11 @@ x-webhooks: type: string enum: - removed - enterprise: *775 - installation: *776 - member: *797 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + member: *799 + organization: *779 + repository: *780 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162145,7 +162382,7 @@ x-webhooks: required: - login - id - team: *807 + team: *809 required: - action - scope @@ -162227,8 +162464,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *776 - merge_group: &809 + installation: *778 + merge_group: &811 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -162247,15 +162484,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *808 + head_commit: *810 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -162341,10 +162578,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *776 - merge_group: *809 - organization: *777 - repository: *778 + installation: *778 + merge_group: *811 + organization: *779 + repository: *780 sender: *4 required: - action @@ -162417,7 +162654,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 + enterprise: *777 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -162526,16 +162763,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *776 - organization: *777 + installation: *778 + organization: *779 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *810 - required: *811 + properties: *812 + required: *813 nullable: true sender: *4 required: @@ -162616,11 +162853,11 @@ x-webhooks: type: string enum: - closed - enterprise: *775 - installation: *776 - milestone: *803 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + milestone: *805 + organization: *779 + repository: *780 sender: *4 required: - action @@ -162699,9 +162936,9 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - milestone: &812 + enterprise: *777 + installation: *778 + milestone: &814 title: Milestone description: A collection of related issues and pull requests. type: object @@ -162838,8 +163075,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -162918,11 +163155,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - milestone: *803 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + milestone: *805 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163032,11 +163269,11 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - milestone: *803 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + milestone: *805 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163116,11 +163353,11 @@ x-webhooks: type: string enum: - opened - enterprise: *775 - installation: *776 - milestone: *812 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + milestone: *814 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163199,11 +163436,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *797 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + blocked_user: *799 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163282,11 +163519,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *797 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + blocked_user: *799 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163365,9 +163602,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - membership: &813 + enterprise: *777 + installation: *778 + membership: &815 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -163474,8 +163711,8 @@ x-webhooks: - role - organization_url - user - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163553,11 +163790,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *775 - installation: *776 - membership: *813 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + membership: *815 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163636,8 +163873,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -163753,10 +163990,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 - user: *797 + user: *799 required: - action - invitation @@ -163834,11 +164071,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *775 - installation: *776 - membership: *813 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + membership: *815 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163925,11 +164162,11 @@ x-webhooks: properties: from: type: string - enterprise: *775 - installation: *776 - membership: *813 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + membership: *815 + organization: *779 + repository: *780 sender: *4 required: - action @@ -164006,9 +164243,9 @@ x-webhooks: type: string enum: - published - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 package: description: Information about the package. type: object @@ -164507,7 +164744,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &814 + items: &816 title: Ruby Gems metadata type: object properties: @@ -164602,7 +164839,7 @@ x-webhooks: - owner - package_version - registry - repository: *778 + repository: *780 sender: *4 required: - action @@ -164678,9 +164915,9 @@ x-webhooks: type: string enum: - updated - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 package: description: Information about the package. type: object @@ -165033,7 +165270,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *814 + items: *816 source_url: type: string format: uri @@ -165103,7 +165340,7 @@ x-webhooks: - owner - package_version - registry - repository: *778 + repository: *780 sender: *4 required: - action @@ -165279,12 +165516,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *775 + enterprise: *777 id: type: integer - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - id @@ -165361,7 +165598,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &815 + personal_access_token_request: &817 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -165507,10 +165744,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *775 - organization: *777 + enterprise: *777 + organization: *779 sender: *4 - installation: *776 + installation: *778 required: - action - personal_access_token_request @@ -165587,11 +165824,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *815 - enterprise: *775 - organization: *777 + personal_access_token_request: *817 + enterprise: *777 + organization: *779 sender: *4 - installation: *776 + installation: *778 required: - action - personal_access_token_request @@ -165667,11 +165904,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *815 - enterprise: *775 - organization: *777 + personal_access_token_request: *817 + enterprise: *777 + organization: *779 sender: *4 - installation: *776 + installation: *778 required: - action - personal_access_token_request @@ -165746,11 +165983,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *815 - organization: *777 - enterprise: *775 + personal_access_token_request: *817 + organization: *779 + enterprise: *777 sender: *4 - installation: *776 + installation: *778 required: - action - personal_access_token_request @@ -165855,7 +166092,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *816 + last_response: *818 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -165887,8 +166124,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 zen: description: Random string of GitHub zen. @@ -166133,10 +166370,10 @@ x-webhooks: - from required: - note - enterprise: *775 - installation: *776 - organization: *777 - project_card: &817 + enterprise: *777 + installation: *778 + organization: *779 + project_card: &819 title: Project Card type: object properties: @@ -166255,7 +166492,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *778 + repository: *780 sender: *4 required: - action @@ -166336,11 +166573,11 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - project_card: *817 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project_card: *819 + repository: *780 sender: *4 required: - action @@ -166420,9 +166657,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 project_card: title: Project Card type: object @@ -166550,8 +166787,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *810 - required: *811 + properties: *812 + required: *813 nullable: true sender: *4 required: @@ -166645,11 +166882,11 @@ x-webhooks: - from required: - note - enterprise: *775 - installation: *776 - organization: *777 - project_card: *817 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project_card: *819 + repository: *780 sender: *4 required: - action @@ -166743,9 +166980,9 @@ x-webhooks: - from required: - column_id - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 project_card: allOf: - title: Project Card @@ -166935,7 +167172,7 @@ x-webhooks: type: string required: - after_id - repository: *778 + repository: *780 sender: *4 required: - action @@ -167015,10 +167252,10 @@ x-webhooks: type: string enum: - closed - enterprise: *775 - installation: *776 - organization: *777 - project: &819 + enterprise: *777 + installation: *778 + organization: *779 + project: &821 title: Project type: object properties: @@ -167142,7 +167379,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *778 + repository: *780 sender: *4 required: - action @@ -167222,10 +167459,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - project_column: &818 + enterprise: *777 + installation: *778 + organization: *779 + project_column: &820 title: Project Column type: object properties: @@ -167264,7 +167501,7 @@ x-webhooks: - name - created_at - updated_at - repository: *778 + repository: *780 sender: *4 required: - action @@ -167343,18 +167580,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - project_column: *818 + enterprise: *777 + installation: *778 + organization: *779 + project_column: *820 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *810 - required: *811 + properties: *812 + required: *813 nullable: true sender: *4 required: @@ -167444,11 +167681,11 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - organization: *777 - project_column: *818 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project_column: *820 + repository: *780 sender: *4 required: - action @@ -167528,11 +167765,11 @@ x-webhooks: type: string enum: - moved - enterprise: *775 - installation: *776 - organization: *777 - project_column: *818 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project_column: *820 + repository: *780 sender: *4 required: - action @@ -167612,11 +167849,11 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - project: *819 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project: *821 + repository: *780 sender: *4 required: - action @@ -167696,18 +167933,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - project: *819 + enterprise: *777 + installation: *778 + organization: *779 + project: *821 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *810 - required: *811 + properties: *812 + required: *813 nullable: true sender: *4 required: @@ -167809,11 +168046,11 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - organization: *777 - project: *819 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project: *821 + repository: *780 sender: *4 required: - action @@ -167892,11 +168129,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *775 - installation: *776 - organization: *777 - project: *819 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project: *821 + repository: *780 sender: *4 required: - action @@ -167977,8 +168214,8 @@ x-webhooks: type: string enum: - closed - installation: *776 - organization: *777 + installation: *778 + organization: *779 projects_v2: *291 sender: *4 required: @@ -168060,8 +168297,8 @@ x-webhooks: type: string enum: - created - installation: *776 - organization: *777 + installation: *778 + organization: *779 projects_v2: *291 sender: *4 required: @@ -168143,8 +168380,8 @@ x-webhooks: type: string enum: - deleted - installation: *776 - organization: *777 + installation: *778 + organization: *779 projects_v2: *291 sender: *4 required: @@ -168262,8 +168499,8 @@ x-webhooks: type: string to: type: string - installation: *776 - organization: *777 + installation: *778 + organization: *779 projects_v2: *291 sender: *4 required: @@ -168347,7 +168584,7 @@ x-webhooks: type: string enum: - archived - changes: &823 + changes: &825 type: object properties: archived_at: @@ -168361,9 +168598,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *776 - organization: *777 - projects_v2_item: &820 + installation: *778 + organization: *779 + projects_v2_item: &822 title: Projects v2 Item description: An item belonging to a project type: object @@ -168498,9 +168735,9 @@ x-webhooks: nullable: true to: type: string - installation: *776 - organization: *777 - projects_v2_item: *820 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -168582,9 +168819,9 @@ x-webhooks: type: string enum: - created - installation: *776 - organization: *777 - projects_v2_item: *820 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -168665,9 +168902,9 @@ x-webhooks: type: string enum: - deleted - installation: *776 - organization: *777 - projects_v2_item: *820 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -168773,7 +169010,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &821 + - &823 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -168795,7 +169032,7 @@ x-webhooks: required: - id - name - - &822 + - &824 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -168829,8 +169066,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *821 - - *822 + - *823 + - *824 required: - field_value - type: object @@ -168846,9 +169083,9 @@ x-webhooks: nullable: true required: - body - installation: *776 - organization: *777 - projects_v2_item: *820 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -168943,9 +169180,9 @@ x-webhooks: to: type: string nullable: true - installation: *776 - organization: *777 - projects_v2_item: *820 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -169028,10 +169265,10 @@ x-webhooks: type: string enum: - restored - changes: *823 - installation: *776 - organization: *777 - projects_v2_item: *820 + changes: *825 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -169113,8 +169350,8 @@ x-webhooks: type: string enum: - reopened - installation: *776 - organization: *777 + installation: *778 + organization: *779 projects_v2: *291 sender: *4 required: @@ -169196,14 +169433,14 @@ x-webhooks: type: string enum: - created - installation: *776 - organization: *777 - projects_v2_status_update: &826 + installation: *778 + organization: *779 + projects_v2_status_update: &828 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *824 - required: *825 + properties: *826 + required: *827 sender: *4 required: - action @@ -169284,9 +169521,9 @@ x-webhooks: type: string enum: - deleted - installation: *776 - organization: *777 - projects_v2_status_update: *826 + installation: *778 + organization: *779 + projects_v2_status_update: *828 sender: *4 required: - action @@ -169422,9 +169659,9 @@ x-webhooks: type: string format: date nullable: true - installation: *776 - organization: *777 - projects_v2_status_update: *826 + installation: *778 + organization: *779 + projects_v2_status_update: *828 sender: *4 required: - action @@ -169495,10 +169732,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - repository @@ -169575,13 +169812,13 @@ x-webhooks: type: string enum: - assigned - assignee: *797 - enterprise: *775 - installation: *776 - number: &827 + assignee: *799 + enterprise: *777 + installation: *778 + number: &829 description: The pull request number. type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -171886,7 +172123,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -171968,11 +172205,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -174272,7 +174509,7 @@ x-webhooks: - draft reason: type: string - repository: *778 + repository: *780 sender: *4 required: - action @@ -174354,11 +174591,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -176658,7 +176895,7 @@ x-webhooks: - draft reason: type: string - repository: *778 + repository: *780 sender: *4 required: - action @@ -176740,11 +176977,11 @@ x-webhooks: type: string enum: - closed - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: &828 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: &830 allOf: - *625 - type: object @@ -176808,7 +177045,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *778 + repository: *780 sender: *4 required: - action @@ -176889,12 +177126,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: *828 - repository: *778 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: *830 + repository: *780 sender: *4 required: - action @@ -176974,11 +177211,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *775 + enterprise: *777 milestone: *609 - number: *827 - organization: *777 - pull_request: &829 + number: *829 + organization: *779 + pull_request: &831 title: Pull Request type: object properties: @@ -179263,7 +179500,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -179342,11 +179579,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -181650,7 +181887,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *778 + repository: *780 sender: *4 required: - action @@ -181774,12 +182011,12 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: *828 - repository: *778 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: *830 + repository: *780 sender: *4 required: - action @@ -181859,11 +182096,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -184152,7 +184389,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -184232,11 +184469,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *775 - installation: *776 - label: *796 - number: *827 - organization: *777 + enterprise: *777 + installation: *778 + label: *798 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -186540,7 +186777,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -186621,10 +186858,10 @@ x-webhooks: type: string enum: - locked - enterprise: *775 - installation: *776 - number: *827 - organization: *777 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -188926,7 +189163,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -189006,12 +189243,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *775 + enterprise: *777 milestone: *609 - number: *827 - organization: *777 - pull_request: *829 - repository: *778 + number: *829 + organization: *779 + pull_request: *831 + repository: *780 sender: *4 required: - action @@ -189090,12 +189327,12 @@ x-webhooks: type: string enum: - opened - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: *828 - repository: *778 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: *830 + repository: *780 sender: *4 required: - action @@ -189176,12 +189413,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: *828 - repository: *778 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: *830 + repository: *780 sender: *4 required: - action @@ -189261,12 +189498,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: *828 - repository: *778 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: *830 + repository: *780 sender: *4 required: - action @@ -189632,9 +189869,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: type: object properties: @@ -191826,7 +192063,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *778 + repository: *780 sender: *4 required: - action @@ -191906,7 +192143,7 @@ x-webhooks: type: string enum: - deleted - comment: &831 + comment: &833 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -192191,9 +192428,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: type: object properties: @@ -194373,7 +194610,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *778 + repository: *780 sender: *4 required: - action @@ -194453,11 +194690,11 @@ x-webhooks: type: string enum: - edited - changes: *830 - comment: *831 - enterprise: *775 - installation: *776 - organization: *777 + changes: *832 + comment: *833 + enterprise: *777 + installation: *778 + organization: *779 pull_request: type: object properties: @@ -196640,7 +196877,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *778 + repository: *780 sender: *4 required: - action @@ -196721,9 +196958,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: title: Simple Pull Request type: object @@ -198918,7 +199155,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *778 + repository: *780 review: description: The review that was affected. type: object @@ -199165,9 +199402,9 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: title: Simple Pull Request type: object @@ -201221,8 +201458,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *778 - review: &832 + repository: *780 + review: &834 description: The review that was affected. type: object properties: @@ -201455,12 +201692,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: description: The pull request number. type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -203765,7 +204002,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 requested_reviewer: title: User type: object @@ -203849,12 +204086,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: description: The pull request number. type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -206166,7 +206403,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 requested_team: title: Team description: Groups of organization members that gives permissions @@ -206358,12 +206595,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: description: The pull request number. type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -208670,7 +208907,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 requested_reviewer: title: User type: object @@ -208755,12 +208992,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: description: The pull request number. type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -211058,7 +211295,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211239,9 +211476,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: title: Simple Pull Request type: object @@ -213438,8 +213675,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *778 - review: *832 + repository: *780 + review: *834 sender: *4 required: - action @@ -213519,9 +213756,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: title: Simple Pull Request type: object @@ -215613,7 +215850,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *778 + repository: *780 sender: *4 thread: type: object @@ -216000,9 +216237,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: title: Simple Pull Request type: object @@ -218080,7 +218317,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *778 + repository: *780 sender: *4 thread: type: object @@ -218404,7 +218641,7 @@ x-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. @@ -218412,10 +218649,8 @@ x-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: @@ -218459,21 +218694,17 @@ x-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: *775 - installation: *776 - number: *827 - organization: *777 + - stacked + enterprise: *777 + installation: *778 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -219467,12 +219698,14 @@ x-webhooks: properties: label: type: string + nullable: true ref: type: string repo: title: Repository description: A git repository type: object + nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -219682,15 +219915,23 @@ x-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 @@ -220188,6 +220429,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -220766,13 +221008,11 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action - number - - before - - after - pull_request - repository - sender @@ -220788,7 +221028,7 @@ x-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. @@ -220796,8 +221036,10 @@ x-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: @@ -220841,18 +221083,21 @@ x-webhooks: content: application/json: schema: - title: pull_request unassigned event + title: pull_request synchronize event type: object properties: action: type: string enum: - - unassigned - assignee: *833 - enterprise: *775 - installation: *776 - number: *827 - organization: *777 + - synchronize + after: + type: string + before: + type: string + enterprise: *777 + installation: *778 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -221205,7 +221450,6 @@ x-webhooks: properties: label: type: string - nullable: true ref: type: string repo: @@ -221847,14 +222091,12 @@ x-webhooks: properties: label: type: string - nullable: true ref: type: string repo: title: Repository description: A git repository type: object - nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -222064,23 +222306,15 @@ x-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 @@ -222578,7 +222812,6 @@ x-webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -223157,13 +223390,16 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 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 @@ -223176,7 +223412,7 @@ x-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. @@ -223184,8 +223420,8 @@ x-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: @@ -223229,18 +223465,18 @@ x-webhooks: content: application/json: schema: - title: pull_request unlabeled event + title: pull_request unassigned event type: object properties: action: type: string enum: - - unlabeled - enterprise: *775 - installation: *776 - label: *796 - number: *827 - organization: *777 + - unassigned + assignee: *835 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -223593,6 +223829,7 @@ x-webhooks: properties: label: type: string + nullable: true ref: type: string repo: @@ -224451,15 +224688,23 @@ x-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 @@ -224957,6 +225202,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -225535,14 +225781,13 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action - number - pull_request - repository - - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -225555,7 +225800,7 @@ x-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. @@ -225563,9 +225808,8 @@ x-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: @@ -225609,17 +225853,18 @@ x-webhooks: content: application/json: schema: - title: pull_request unlocked event + title: pull_request unlabeled event type: object properties: action: type: string enum: - - unlocked - enterprise: *775 - installation: *776 - number: *827 - organization: *777 + - unlabeled + enterprise: *777 + installation: *778 + label: *798 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -225780,6 +226025,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -225851,6 +226097,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -225883,6 +226130,7 @@ x-webhooks: commit_title: description: Title for the merge commit message. type: string + nullable: true enabled_by: title: User type: object @@ -226610,6 +226858,7 @@ x-webhooks: properties: label: type: string + nullable: true ref: type: string repo: @@ -226826,23 +227075,15 @@ x-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 @@ -227424,6 +227665,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -227562,6 +227804,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -227670,6 +227913,15 @@ x-webhooks: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -227861,6 +228113,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -227906,7 +228159,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -227926,20 +228179,19 @@ x-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 @@ -227953,7 +228205,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: push + example: pull_request schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -227981,487 +228233,2859 @@ x-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 - nullable: true - 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 - nullable: true - 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 - nullable: true - 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. + action: type: string - created: - description: Whether this push created the `ref`. - type: boolean - deleted: - description: Whether this push deleted the `ref`. - type: boolean - enterprise: *775 - forced: - description: Whether this push was a force push of the `ref`. - type: boolean - head_commit: - title: Commit + enum: + - unlocked + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: + title: Pull Request type: object - nullable: true 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 - nullable: true - 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. + _links: type: object properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string + 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: - - 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: *776 - organization: *777 - pusher: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - 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: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: type: string nullable: true - 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 - nullable: true - 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 - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - 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 - nullable: true - 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: + - resolved + - off-topic + - too heated + - spam + - null + additions: type: integer - organization: - type: string - owner: + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + 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 + nullable: true + properties: + commit_message: + description: Commit message for the merge commit. + type: string + nullable: true + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + changed_files: + type: integer + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - 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 + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull + request. + type: boolean + merge_commit_sha: + type: string + nullable: true + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true + merged_at: + type: string + nullable: true + format: date-time + merged_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within + its repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: boolean + nullable: true + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - 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: *780 + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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: *777 + forced: + description: Whether this push was a force push of the `ref`. + type: boolean + head_commit: + title: Commit + type: object + nullable: true + 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 + nullable: true + 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 + nullable: true + 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: *778 + organization: *779 + pusher: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 nullable: true @@ -228785,9 +231409,9 @@ x-webhooks: type: string enum: - published - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 registry_package: type: object properties: @@ -229233,7 +231857,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *814 + items: *816 summary: type: string tag_name: @@ -229287,7 +231911,7 @@ x-webhooks: - owner - package_version - registry - repository: *778 + repository: *780 sender: *4 required: - action @@ -229365,9 +231989,9 @@ x-webhooks: type: string enum: - updated - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 registry_package: type: object properties: @@ -229675,7 +232299,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *814 + items: *816 summary: type: string tag_name: @@ -229724,7 +232348,7 @@ x-webhooks: - owner - package_version - registry - repository: *778 + repository: *780 sender: *4 required: - action @@ -229801,10 +232425,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - release: &834 + enterprise: *777 + installation: *778 + organization: *779 + release: &836 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -230122,7 +232746,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *778 + repository: *780 sender: *4 required: - action @@ -230199,11 +232823,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - release: *834 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + release: *836 + repository: *780 sender: *4 required: - action @@ -230320,11 +232944,11 @@ x-webhooks: type: boolean required: - to - enterprise: *775 - installation: *776 - organization: *777 - release: *834 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + release: *836 + repository: *780 sender: *4 required: - action @@ -230402,9 +233026,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -230726,7 +233350,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *778 + repository: *780 sender: *4 required: - action @@ -230802,10 +233426,10 @@ x-webhooks: type: string enum: - published - enterprise: *775 - installation: *776 - organization: *777 - release: &835 + enterprise: *777 + installation: *778 + organization: *779 + release: &837 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -231124,7 +233748,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *778 + repository: *780 sender: *4 required: - action @@ -231200,11 +233824,11 @@ x-webhooks: type: string enum: - released - enterprise: *775 - installation: *776 - organization: *777 - release: *834 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + release: *836 + repository: *780 sender: *4 required: - action @@ -231280,11 +233904,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *775 - installation: *776 - organization: *777 - release: *835 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + release: *837 + repository: *780 sender: *4 required: - action @@ -231360,11 +233984,11 @@ x-webhooks: type: string enum: - published - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - repository_advisory: *695 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + repository_advisory: *697 sender: *4 required: - action @@ -231440,11 +234064,11 @@ x-webhooks: type: string enum: - reported - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - repository_advisory: *695 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + repository_advisory: *697 sender: *4 required: - action @@ -231520,10 +234144,10 @@ x-webhooks: type: string enum: - archived - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -231600,10 +234224,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -231681,10 +234305,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -231768,10 +234392,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -231883,10 +234507,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -231958,10 +234582,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 status: type: string @@ -232042,10 +234666,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -232122,10 +234746,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -232219,10 +234843,10 @@ x-webhooks: - name required: - repository - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -232302,10 +234926,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 repository_ruleset: *339 sender: *4 required: @@ -232384,10 +235008,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 repository_ruleset: *339 sender: *4 required: @@ -232466,10 +235090,10 @@ x-webhooks: type: string enum: - edited - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 repository_ruleset: *339 changes: type: object @@ -232774,10 +235398,10 @@ x-webhooks: - from required: - owner - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -232855,10 +235479,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -232936,7 +235560,7 @@ x-webhooks: type: string enum: - create - alert: &836 + alert: &838 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -233058,10 +235682,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233267,10 +235891,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233348,11 +235972,11 @@ x-webhooks: type: string enum: - reopen - alert: *836 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *838 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233551,10 +236175,10 @@ x-webhooks: enum: - fixed - open - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233632,7 +236256,7 @@ x-webhooks: type: string enum: - assigned - alert: &837 + alert: &840 type: object properties: number: *188 @@ -233774,11 +236398,12 @@ x-webhooks: properties: *20 required: *21 nullable: true + metadata: *839 assignee: *4 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233856,11 +236481,11 @@ x-webhooks: type: string enum: - created - alert: *837 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233941,11 +236566,11 @@ x-webhooks: type: string enum: - created - alert: *837 - installation: *776 - location: *838 - organization: *777 - repository: *778 + alert: *840 + installation: *778 + location: *841 + organization: *779 + repository: *780 sender: *4 required: - location @@ -234123,6 +236748,168 @@ x-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: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + 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: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + 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: |- @@ -234183,11 +236970,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *837 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -234265,11 +237052,11 @@ x-webhooks: type: string enum: - reopened - alert: *837 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -234347,11 +237134,11 @@ x-webhooks: type: string enum: - resolved - alert: *837 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -234429,12 +237216,12 @@ x-webhooks: type: string enum: - unassigned - alert: *837 + alert: *840 assignee: *4 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -234512,11 +237299,11 @@ x-webhooks: type: string enum: - validated - alert: *837 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -234642,10 +237429,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *778 - enterprise: *775 - installation: *776 - organization: *777 + repository: *780 + enterprise: *777 + installation: *778 + organization: *779 sender: *4 required: - action @@ -234723,11 +237510,11 @@ x-webhooks: type: string enum: - published - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - security_advisory: &839 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + security_advisory: &842 description: The details of the security advisory, including summary, description, and severity. type: object @@ -234910,11 +237697,11 @@ x-webhooks: type: string enum: - updated - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - security_advisory: *839 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + security_advisory: *842 sender: *4 required: - action @@ -234987,10 +237774,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -235175,9 +237962,9 @@ x-webhooks: type: object properties: security_and_analysis: *312 - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: *357 sender: *4 required: @@ -235256,12 +238043,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: &840 + sponsorship: &843 type: object properties: created_at: @@ -235562,12 +238349,12 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: *840 + sponsorship: *843 required: - action - sponsorship @@ -235655,12 +238442,12 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: *840 + sponsorship: *843 required: - action - changes @@ -235737,17 +238524,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &841 + effective_date: &844 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: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: *840 + sponsorship: *843 required: - action - sponsorship @@ -235821,7 +238608,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &842 + changes: &845 type: object properties: tier: @@ -235865,13 +238652,13 @@ x-webhooks: - from required: - tier - effective_date: *841 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + effective_date: *844 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: *840 + sponsorship: *843 required: - action - changes @@ -235948,13 +238735,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *842 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + changes: *845 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: *840 + sponsorship: *843 required: - action - changes @@ -236028,10 +238815,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236114,10 +238901,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236537,15 +239324,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *775 + enterprise: *777 id: description: The unique identifier of the status. type: integer - installation: *776 + installation: *778 name: type: string - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 sha: description: The Commit SHA. @@ -236660,9 +239447,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -236751,9 +239538,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -236842,9 +239629,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -236933,9 +239720,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -237011,12 +239798,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - team: &843 + team: &846 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -237239,9 +240026,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: title: Repository description: A git repository @@ -237699,7 +240486,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *843 + team: *846 required: - action - team @@ -237775,9 +240562,9 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: title: Repository description: A git repository @@ -238235,7 +241022,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *843 + team: *846 required: - action - team @@ -238312,9 +241099,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: title: Repository description: A git repository @@ -238772,7 +241559,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *843 + team: *846 required: - action - team @@ -238916,9 +241703,9 @@ x-webhooks: - from required: - permissions - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: title: Repository description: A git repository @@ -239376,7 +242163,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *843 + team: *846 required: - action - changes @@ -239454,9 +242241,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: title: Repository description: A git repository @@ -239914,7 +242701,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *843 + team: *846 required: - action - team @@ -239990,10 +242777,10 @@ x-webhooks: type: string enum: - started - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -240066,16 +242853,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *775 + enterprise: *777 inputs: type: object nullable: true additionalProperties: true - installation: *776 - organization: *777 + installation: *778 + organization: *779 ref: type: string - repository: *778 + repository: *780 sender: *4 workflow: type: string @@ -240157,10 +242944,10 @@ x-webhooks: type: string enum: - completed - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 workflow_job: allOf: @@ -240476,10 +243263,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 workflow_job: allOf: @@ -240818,10 +243605,10 @@ x-webhooks: type: string enum: - queued - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 workflow_job: type: object @@ -241035,10 +243822,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 workflow_job: type: object @@ -241254,12 +244041,12 @@ x-webhooks: type: string enum: - completed - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - workflow: *792 + workflow: *794 workflow_run: title: Workflow Run type: object @@ -242258,12 +245045,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - workflow: *792 + workflow: *794 workflow_run: title: Workflow Run type: object @@ -243247,12 +246034,12 @@ x-webhooks: type: string enum: - requested - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - workflow: *792 + workflow: *794 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index dca08b7120..0b58c91f50 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -206551,6 +206551,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." @@ -207848,6 +207891,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." @@ -209214,6 +209300,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." @@ -211321,6 +211450,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." @@ -212643,6 +212815,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." @@ -214005,6 +214220,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." @@ -215588,6 +215846,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": { @@ -549773,6 +550049,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." @@ -551630,6 +551949,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." @@ -552794,6 +553156,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." @@ -554166,6 +554571,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." @@ -556292,6 +556740,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." @@ -557471,6 +557962,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." @@ -558839,6 +559373,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." @@ -560438,6 +561015,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": { @@ -562902,6 +563497,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -562930,7 +563547,13 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ] } } } @@ -564224,6 +564847,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -564272,6 +564917,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -1274544,11 +1275195,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" }, @@ -1274615,21 +1275266,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).\"", @@ -1276079,7 +1276724,8 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": "string", + "nullable": true }, "ref": { "type": "string" @@ -1276088,6 +1276734,7 @@ "title": "Repository", "description": "A git repository", "type": "object", + "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1276361,7 +1277008,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", @@ -1276370,7 +1277017,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", @@ -1276998,7 +1277645,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1279104,8 +1279752,6 @@ "required": [ "action", "number", - "before", - "after", "pull_request", "repository", "sender" @@ -1279131,11 +1279777,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" }, @@ -1279202,110 +1279848,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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "after": { + "type": "string" + }, + "before": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -1279949,8 +1280505,7 @@ "type": "object", "properties": { "label": { - "type": "string", - "nullable": true + "type": "string" }, "ref": { "type": "string" @@ -1280757,8 +1281312,7 @@ "type": "object", "properties": { "label": { - "type": "string", - "nullable": true + "type": "string" }, "ref": { "type": "string" @@ -1280767,7 +1281321,6 @@ "title": "Repository", "description": "A git repository", "type": "object", - "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1281041,7 +1281594,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", @@ -1281050,7 +1281603,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", @@ -1281678,8 +1282231,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -1283785,8 +1284337,11 @@ "required": [ "action", "number", + "before", + "after", "pull_request", - "repository" + "repository", + "sender" ] } } @@ -1283809,11 +1284364,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" }, @@ -1283880,13 +1284435,109 @@ "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -1283978,47 +1284629,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", - "nullable": true - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "number": { "description": "The pull request number.", "type": "integer" @@ -1284572,7 +1285182,8 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": "string", + "nullable": true }, "ref": { "type": "string" @@ -1285663,7 +1286274,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", @@ -1285672,7 +1286283,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", @@ -1286300,7 +1286911,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1288407,8 +1289019,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ] } } @@ -1288431,11 +1289042,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" }, @@ -1288502,13 +1289113,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": { @@ -1288600,6 +1289211,47 @@ "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", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "number": { "description": "The pull request number.", "type": "integer" @@ -1288893,7 +1289545,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1288990,7 +1289643,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1289032,7 +1289686,8 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": "string", + "nullable": true }, "enabled_by": { "title": "User", @@ -1289957,7 +1290612,8 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": "string", + "nullable": true }, "ref": { "type": "string" @@ -1290240,7 +1290896,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", @@ -1290249,7 +1290905,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", @@ -1290990,7 +1291646,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1291174,7 +1291831,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1291316,7 +1291974,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -1291569,7 +1292236,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1292996,12 +1293664,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": [ { @@ -1293023,7 +1293692,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "push", + "example": "pull_request", "schema": { "type": "string" } @@ -1293066,151 +1293735,14 @@ "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": { + "action": { "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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", - "nullable": true, - "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" + "enum": [ + "unlocked" + ] }, "enterprise": { "title": "Enterprise", @@ -1293280,126 +1293812,6 @@ "avatar_url" ] }, - "forced": { - "description": "Whether this push was a force push of the `ref`.", - "type": "boolean" - }, - "head_commit": { - "title": "Commit", - "type": "object", - "nullable": true, - "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", - "nullable": true, - "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", - "nullable": true, - "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).\"", @@ -1293421,6 +1293833,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.", @@ -1293494,351 +1293910,144 @@ "description" ] }, - "pusher": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": "string", - "nullable": true, - "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": { - "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", - "nullable": true - }, - "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", - "nullable": true - }, - "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", - "nullable": true - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", + "_links": { "type": "object", - "nullable": true, "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", - "nullable": true, - "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", "nullable": true, - "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", "nullable": true, @@ -1293933,756 +1294142,169 @@ "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": { - "nullable": true, - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": "string", - "nullable": true - }, - "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "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" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "MDQ6VXNlcjU4MzIzMQ==" - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "registry_package": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "owner": { + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", "type": "object", + "nullable": true, "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", + "nullable": true }, - "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", - "nullable": true, - "properties": { - "author": { + "enabled_by": { + "title": "User", "type": "object", + "nullable": true, "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true }, "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" @@ -1294690,32 +1294312,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" @@ -1294723,428 +1294359,399 @@ }, "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", - "nullable": true + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false }, - "manifest": { - "type": "object", - "nullable": true + "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", - "nullable": true, - "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" - } - ], - "nullable": true + "allow_update_branch": { + "type": "boolean" }, - "bugs": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], - "nullable": true + "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": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], - "nullable": true + "collaborators_url": { + "type": "string", + "format": "uri-template" }, - "git_head": { - "type": "string" + "comments_url": { + "type": "string", + "format": "uri-template" }, - "homepage": { - "type": "string" + "commits_url": { + "type": "string", + "format": "uri-template" }, - "license": { - "type": "string" + "compare_url": { + "type": "string", + "format": "uri-template" }, - "main": { - "type": "string" + "contents_url": { + "type": "string", + "format": "uri-template" }, - "repository": { + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { "oneOf": [ { - "type": "string" + "type": "integer" }, { - "type": "object" + "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", "nullable": true }, - "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": { + "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" }, - "maintainers": { - "type": "array", - "items": { - "type": "string" - } + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true }, - "contributors": { - "type": "array", - "items": { - "type": "string" - } + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true }, - "engines": { - "type": "object" + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false }, - "keywords": { - "type": "array", - "items": { - "type": "string" - } + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true }, - "files": { - "type": "array", - "items": { - "type": "string" - } + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] }, - "bin": { - "type": "object" + "homepage": { + "type": "string", + "nullable": true }, - "man": { - "type": "object" + "hooks_url": { + "type": "string", + "format": "uri" }, - "directories": { - "oneOf": [ - { + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { "type": "string" }, - { - "type": "object" + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" } - ], - "nullable": true + }, + "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": { - "type": "string" + "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" + ] }, - "installation_command": { - "type": "string" + "merges_url": { + "type": "string", + "format": "uri" }, - "release_id": { - "type": "integer" + "milestones_url": { + "type": "string", + "format": "uri-template" }, - "commit_oid": { + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", "type": "string" }, - "published_via_actions": { - "type": "boolean" + "node_id": { + "type": "string" }, - "deleted_by_id": { + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { "type": "integer" - } - } - }, - "nuget_metadata": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "integer" - } - ], - "nullable": true - }, - "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", - "nullable": true - }, - "name": { - "type": "string" - }, - "sha1": { - "type": "string", - "nullable": true - }, - "sha256": { - "type": "string", - "nullable": true - }, - "size": { - "type": "integer" - }, - "state": { - "type": "string", - "nullable": true - }, - "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": { + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", "type": "object", + "nullable": true, "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true }, "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" @@ -1295152,1888 +1294759,2055 @@ "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" } - } - }, - "created_at": { - "type": "string" - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string", - "nullable": true + }, + "required": [ + "login", + "id" + ] }, - "prerelease": { + "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" }, - "published_at": { + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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" }, - "tag_name": { + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "target_commitish": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { "type": "string" }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "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", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "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" }, - "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" - } + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "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" } - }, - "platform": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { + ] + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" } }, - "repo": { - "type": "string" + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } }, - "dependencies": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" } }, - "commit_oid": { + "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": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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" } - } - }, - "summary": { - "type": "string" - }, - "tag_name": { - "type": "string" - }, - "target_commitish": { - "type": "string" - }, - "target_oid": { - "type": "string" + }, + "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" + ] }, - "updated_at": { + "sha": { "type": "string" }, - "version": { - "type": "string" + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] } }, "required": [ - "id", - "version", - "name", - "description", - "summary", - "html_url", - "metadata", - "package_files", - "installation_command", - "package_url" + "label", + "ref", + "sha", + "user", + "repo" ] }, - "registry": { - "type": "object", - "nullable": true, - "properties": { - "about_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" + "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", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } }, - "vendor": { - "type": "string" - } + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] } }, - "updated_at": { - "type": "string", + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "mergeable": { + "type": "boolean", "nullable": true - } - }, - "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", - "example": 42, - "type": "integer", - "format": "int64" }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "mergeable_state": { + "type": "string" }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" + "merged": { + "type": "boolean", + "nullable": true }, - "full_name": { + "merged_at": { "type": "string", - "example": "octocat/Hello-World" + "nullable": true, + "format": "date-time" }, - "license": { - "title": "License Simple", - "description": "License Simple", + "merged_by": { + "title": "User", "type": "object", + "nullable": true, "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { + "avatar_url": { "type": "string", - "example": "MIT License" + "format": "uri" }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "deleted": { + "type": "boolean" }, - "spdx_id": { + "email": { "type": "string", - "nullable": true, - "example": "MIT" + "nullable": true }, - "node_id": { + "events_url": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "format": "uri-template" }, - "html_url": { + "followers_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 }, - "node_id": { + "following_url": { "type": "string", - "example": "MDQ6VXNlcjE=" + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri-template" }, "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "login": { + "type": "string" }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "name": { + "type": "string" }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "node_id": { + "type": "string" }, - "subscriptions_url": { + "organizations_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" }, - "organizations_url": { + "received_events_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri" }, "type": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "Bot", + "User", + "Organization" + ] }, - "starred_at": { + "url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri" }, "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "id" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", + "nullable": true, "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { + "closed_at": { "type": "string", - "example": "octocat" + "nullable": true, + "format": "date-time" }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 + "closed_issues": { + "type": "integer" }, - "node_id": { + "created_at": { "type": "string", - "example": "MDQ6VXNlcjE=" + "format": "date-time" }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] }, - "gravatar_id": { + "description": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "url": { + "due_on": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "nullable": true, + "format": "date-time" }, "html_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "id": { + "type": "integer" }, - "organizations_url": { + "labels_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "uri" }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "node_id": { + "type": "string" }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "number": { + "description": "The number of the milestone.", + "type": "integer" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "open_issues": { + "type": "integer" }, - "type": { + "state": { + "description": "The state of the milestone.", "type": "string", - "example": "User" + "enum": [ + "open", + "closed" + ] }, - "site_admin": { - "type": "boolean" + "title": { + "description": "The title of the milestone.", + "type": "string" }, - "starred_at": { + "updated_at": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "date-time" }, - "user_view_type": { + "url": { "type": "string", - "example": "public" + "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 + "node_id": { + "type": "string" }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" }, - "default_branch": { - "description": "The default branch of the repository.", + "patch_url": { "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 + "format": "uri" }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "rebaseable": { "type": "boolean", - "example": true + "nullable": true }, - "topics": { + "requested_reviewers": { "type": "array", "items": { - "type": "string" - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } }, - "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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" + } }, - "site_admin": { - "type": "boolean" - } + "required": [ + "name", + "id" + ] } - }, - "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": { + ] + } + }, + "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", + "nullable": true + }, + "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" - } - }, - "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" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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" + } }, - "pull": { - "type": "boolean" - } + "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" } }, - "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" - } + "required": [ + "name", + "id" + ] } }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false - }, - "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": { + "review_comment_url": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" + "format": "uri-template" }, - "watchers": { + "review_comments": { "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "action", - "registry_package", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "registry_package", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "registry-package-updated": { - "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", - "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": [ - "updated" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", + "review_comments_url": { "type": "string", - "nullable": true, "format": "uri" }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" + "enum": [ + "open", + "closed" + ] }, - "avatar_url": { + "statuses_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "MDQ6VXNlcjU4MzIzMQ==" - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" }, - "id": { - "type": "integer", - "example": 1 + "title": { + "description": "The title of the pull request.", + "type": "string" }, - "node_id": { + "updated_at": { "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "format": "date-time" }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "registry_package": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "nullable": true - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" + "format": "uri" }, - "owner": { + "user": { + "title": "User", "type": "object", + "nullable": true, "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true }, "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" + "type": "integer", + "format": "int64" }, "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" @@ -1297041,457 +1296815,46 @@ }, "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", - "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", - "nullable": true, - "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", - "nullable": true - }, - "name": { - "type": "string" - }, - "sha1": { - "type": "string", - "nullable": true - }, - "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" + "id" ] - }, - "registry": { - "type": "object", - "nullable": true - }, - "updated_at": { - "type": "string" } }, "required": [ + "url", "id", - "name", - "namespace", - "description", - "ecosystem", - "package_type", + "node_id", "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", "created_at", "updated_at", - "owner", - "package_version", - "registry" + "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": { @@ -1298840,7 +1298203,9 @@ }, "required": [ "action", - "registry_package", + "number", + "pull_request", + "repository", "sender" ] } @@ -1298855,7 +1298220,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -1298864,13 +1298229,12 @@ } } }, - "release-created": { + "push": { "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 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#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1298892,7 +1298256,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "push", "schema": { "type": "string" } @@ -1298935,14 +1298299,151 @@ "content": { "application/json": { "schema": { - "title": "release created event", + "title": "push event", "type": "object", "properties": { - "action": { + "after": { + "description": "The SHA of the most recent commit on `ref` after the push.", + "type": "string" + }, + "base_ref": { "type": "string", - "enum": [ - "created" - ] + "nullable": true + }, + "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", + "nullable": true, + "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", + "nullable": true, + "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", @@ -1299012,19 +1298513,139 @@ "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).\"", + "forced": { + "description": "Whether this push was a force push of the `ref`.", + "type": "boolean" + }, + "head_commit": { + "title": "Commit", "type": "object", + "nullable": true, "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 + "added": { + "description": "An array of files added in the commit.", + "type": "array", + "items": { + "type": "string" + } }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "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).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", "example": "MDQ6VXNlcjU4MzIzMQ==" } }, @@ -1299106,1062 +1298727,226 @@ "description" ] }, - "release": { - "title": "Release", - "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "pusher": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", "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", - "nullable": true - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "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" - }, - "author": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "body": { - "type": "string", - "nullable": true - }, - "created_at": { + "date": { "type": "string", - "nullable": true, "format": "date-time" }, - "updated_at": { + "email": { "type": "string", "nullable": true, - "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" + "format": "email" }, "name": { - "type": "string", - "nullable": true - }, - "node_id": { - "type": "string" - }, - "prerelease": { - "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" - }, - "published_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "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" - ] - }, - "tag_name": { - "description": "The name of the tag.", + "description": "The git author's name.", "type": "string" }, - "tarball_url": { - "type": "string", - "nullable": true, - "format": "uri" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", + "username": { "type": "string" - }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, - "url": { - "type": "string", - "format": "uri" - }, - "zipball_url": { - "type": "string", - "nullable": true, - "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" + "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": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "description": "A git repository", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, + "allow_forking": { + "description": "Whether to allow private forks", "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true }, - "fork": { - "type": "boolean" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "allow_update_branch": { + "type": "boolean" }, "archive_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false }, "assignees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "format": "uri-template" }, "blobs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "format": "uri-template" }, "branches_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" }, "collaborators_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "format": "uri-template" }, "comments_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "format": "uri-template" }, "commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "format": "uri-template" }, "compare_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "format": "uri-template" }, "contents_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "format": "uri-template" }, "contributors_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "format": "uri" }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "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 }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false }, - "stargazers_url": { + "deployments_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "format": "uri" }, - "statuses_url": { + "description": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "nullable": true }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" }, - "subscription_url": { + "downloads_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "format": "uri" }, - "tags_url": { + "events_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "format": "uri" }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "fork": { + "type": "boolean" }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "forks": { + "type": "integer" }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "forks_count": { + "type": "integer" }, - "mirror_url": { + "forks_url": { "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true + "format": "uri" }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + "full_name": { + "type": "string" }, - "svn_url": { + "git_commits_url": { "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "format": "uri-template" }, - "homepage": { + "git_refs_url": { "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true + "format": "uri-template" }, - "language": { + "git_tags_url": { "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 + "format": "uri-template" }, - "default_branch": { - "description": "The default branch of the repository.", + "git_url": { "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 + "format": "uri" }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "has_downloads": { + "description": "Whether downloads are enabled.", "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "default": true }, "has_issues": { "description": "Whether issues are enabled.", - "default": true, "type": "boolean", - "example": true + "default": true + }, + "has_pages": { + "type": "boolean" }, "has_projects": { "description": "Whether projects are enabled.", - "default": true, "type": "boolean", - "example": true + "default": true }, "has_wiki": { "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, "type": "boolean", - "example": true + "default": true }, "has_discussions": { "description": "Whether discussions are enabled.", - "default": false, "type": "boolean", - "example": true + "default": false }, "has_pull_requests": { "description": "Whether pull requests are enabled.", - "default": true, "type": "boolean", - "example": true + "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", @@ -1300171,577 +1298956,425 @@ "collaborators_only" ] }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, + "homepage": { + "type": "string", + "nullable": true + }, + "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" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "issue_comment_url": { + "type": "string", + "format": "uri-template" }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" + "issue_events_url": { + "type": "string", + "format": "uri-template" }, - "pushed_at": { + "issues_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true + "format": "uri-template" }, - "created_at": { + "keys_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true + "format": "uri-template" }, - "updated_at": { + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", "nullable": true }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true + "languages_url": { + "type": "string", + "format": "uri" }, - "template_repository": { - "nullable": true, + "license": { + "title": "License", "type": "object", + "nullable": true, "properties": { - "id": { - "type": "integer" - }, - "node_id": { + "key": { "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": { + "node_id": { "type": "string" }, - "description": { + "spdx_id": { "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" + "type": "string", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "deployments_url": { - "type": "string" + "deleted": { + "type": "boolean" }, - "downloads_url": { - "type": "string" + "email": { + "type": "string", + "nullable": true }, "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" + "type": "string", + "format": "uri-template" }, - "teams_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri" }, - "trees_url": { - "type": "string" + "following_url": { + "type": "string", + "format": "uri-template" }, - "clone_url": { - "type": "string" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "mirror_url": { + "gravatar_id": { "type": "string" }, - "hooks_url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "svn_url": { - "type": "string" + "id": { + "type": "integer" }, - "homepage": { + "login": { "type": "string" }, - "language": { + "name": { "type": "string" }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { + "node_id": { "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" + "organizations_url": { + "type": "string", + "format": "uri" }, - "has_downloads": { - "type": "boolean" + "received_events_url": { + "type": "string", + "format": "uri" }, - "archived": { - "type": "boolean" + "repos_url": { + "type": "string", + "format": "uri" }, - "disabled": { + "site_admin": { "type": "boolean" }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" + "starred_url": { + "type": "string", + "format": "uri-template" }, - "updated_at": { - "type": "string" + "subscriptions_url": { + "type": "string", + "format": "uri" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, - "allow_rebase_merge": { - "type": "boolean" + "url": { + "type": "string", + "format": "uri" }, - "temp_clone_token": { + "user_view_type": { "type": "string" - }, - "allow_squash_merge": { + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, - "allow_auto_merge": { + "maintain": { "type": "boolean" }, - "delete_branch_on_merge": { + "pull": { "type": "boolean" }, - "allow_update_branch": { + "push": { "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": { + "triage": { "type": "boolean" - }, - "subscribers_count": { + } + }, + "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": { + "nullable": true, + "oneOf": [ + { "type": "integer" }, - "network_count": { - "type": "integer" + { + "type": "string", + "format": "date-time" } - } + ] }, - "temp_clone_token": { + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { "type": "string" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true + "stargazers": { + "type": "integer" }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false + "stargazers_count": { + "type": "integer" }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false + "stargazers_url": { + "type": "string", + "format": "uri" }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false + "statuses_url": { + "type": "string", + "format": "uri-template" }, - "squash_merge_commit_title": { + "subscribers_url": { "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)." + "format": "uri" }, - "squash_merge_commit_message": { + "subscription_url": { "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." + "format": "uri" }, - "merge_commit_title": { + "svn_url": { "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)." + "format": "uri" }, - "merge_commit_message": { + "tags_url": { "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." + "format": "uri" }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true + "teams_url": { + "type": "string", + "format": "uri" }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" + "topics": { + "type": "array", + "items": { + "type": "string" + } }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" + "trees_url": { + "type": "string", + "format": "uri-template" }, - "subscribers_count": { - "type": "integer" + "updated_at": { + "type": "string", + "format": "date-time" }, - "network_count": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" }, - "open_issues": { - "type": "integer" + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] }, "watchers": { "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" + "watchers_count": { + "type": "integer" }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", "description", - "downloads_url", - "events_url", "fork", + "url", "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", + "keys_url", + "collaborators_url", + "teams_url", "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", "issue_events_url", - "issues_url", - "keys_url", - "labels_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", - "name", "notifications_url", - "owner", - "private", - "pulls_url", + "labels_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", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", "git_url", - "has_downloads", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", "has_issues", "has_projects", + "has_downloads", "has_wiki", "has_pages", - "homepage", - "language", - "archived", - "disabled", + "has_discussions", + "forks_count", "mirror_url", - "open_issues", + "archived", "open_issues_count", "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", + "forks", + "open_issues", "watchers", - "watchers_count", - "created_at", - "updated_at" + "default_branch", + "topics", + "visibility" ] }, "sender": { @@ -1300870,10 +1299503,18 @@ } }, "required": [ - "action", - "release", + "ref", + "before", + "after", + "created", + "deleted", + "forced", + "base_ref", + "compare", + "commits", + "head_commit", "repository", - "sender" + "pusher" ] } } @@ -1300887,7 +1299528,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "push", "supported-webhook-types": [ "repository", "organization", @@ -1300896,13 +1299537,13 @@ } } }, - "release-deleted": { + "registry-package-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, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "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#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -1300924,7 +1299565,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -1300967,13 +1299608,12 @@ "content": { "application/json": { "schema": { - "title": "release deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "published" ] }, "enterprise": { @@ -1301138,220 +1299778,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", - "nullable": true - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "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" - ] - } + "created_at": { + "type": "string", + "nullable": true }, - "assets_url": { + "description": { "type": "string", - "format": "uri" + "nullable": true }, - "author": { - "title": "User", + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { "type": "object", - "nullable": true, "properties": { "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true + "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" @@ -1301359,46 +1299834,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" @@ -1301406,155 +1299867,713 @@ }, "required": [ "login", - "id" + "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", - "nullable": true - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "updated_at": { - "type": "string", - "nullable": true, - "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", - "nullable": true - }, - "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", - "nullable": true, - "format": "date-time" - }, - "reactions": { - "title": "Reactions", + "package_version": { "type": "object", + "nullable": true, "properties": { - "+1": { - "type": "integer" + "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" + ] }, - "-1": { - "type": "integer" + "body": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] }, - "confused": { - "type": "integer" + "body_html": { + "type": "string" }, - "eyes": { - "type": "integer" + "container_metadata": { + "type": "object", + "properties": { + "labels": { + "type": "object", + "nullable": true + }, + "manifest": { + "type": "object", + "nullable": true + }, + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } }, - "heart": { - "type": "integer" + "created_at": { + "type": "string" }, - "hooray": { - "type": "integer" + "description": { + "type": "string" }, - "laugh": { - "type": "integer" + "docker_metadata": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } }, - "rocket": { - "type": "integer" + "draft": { + "type": "boolean" }, - "total_count": { + "html_url": { + "type": "string" + }, + "id": { "type": "integer" }, - "url": { - "type": "string", - "format": "uri" + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "npm_metadata": { + "type": "object", + "nullable": true, + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "npm_user": { + "type": "string" + }, + "author": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "bugs": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "dependencies": { + "type": "object" + }, + "dev_dependencies": { + "type": "object" + }, + "peer_dependencies": { + "type": "object" + }, + "optional_dependencies": { + "type": "object" + }, + "description": { + "type": "string" + }, + "dist": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "git_head": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "license": { + "type": "string" + }, + "main": { + "type": "string" + }, + "repository": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "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" + } + ], + "nullable": true + }, + "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", + "nullable": true, + "items": { + "type": "object", + "properties": { + "id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "integer" + } + ], + "nullable": true + }, + "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", + "nullable": true + }, + "name": { + "type": "string" + }, + "sha1": { + "type": "string", + "nullable": true + }, + "sha256": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "state": { + "type": "string", + "nullable": true + }, + "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" + }, + "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" + } + } + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "nullable": true + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "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": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "version", + "name", + "description", + "summary", + "html_url", + "metadata", + "package_files", + "installation_command", + "package_url" ] }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "tarball_url": { - "type": "string", + "registry": { + "type": "object", "nullable": true, - "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" + "properties": { + "about_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "vendor": { + "type": "string" + } + } }, - "zipball_url": { + "updated_at": { "type": "string", - "nullable": true, - "format": "uri" + "nullable": true } }, "required": [ - "url", - "assets_url", - "upload_url", - "html_url", "id", - "node_id", - "tag_name", - "target_commitish", "name", - "draft", - "author", - "prerelease", - "immutable", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", "created_at", - "published_at", - "assets", - "tarball_url", "updated_at", - "zipball_url", - "body" + "owner", + "package_version", + "registry" ] }, "repository": { @@ -1302903,8 +1301922,7 @@ }, "required": [ "action", - "release", - "repository", + "registry_package", "sender" ] } @@ -1302919,7 +1301937,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -1302928,13 +1301946,13 @@ } } }, - "release-edited": { + "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": "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", + "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": [ { @@ -1302956,7 +1301974,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -1302999,68 +1302017,14 @@ "content": { "application/json": { "schema": { - "title": "release edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "updated" ] }, - "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).\"", @@ -1303223,220 +1302187,53 @@ "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", - "nullable": true - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "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" - ] - } + "created_at": { + "type": "string" }, - "assets_url": { - "type": "string", - "format": "uri" + "description": { + "nullable": true }, - "author": { - "title": "User", + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { "type": "object", - "nullable": true, "properties": { "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true + "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" @@ -1303444,46 +1302241,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" @@ -1303491,155 +1302274,457 @@ }, "required": [ "login", - "id" + "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", - "nullable": true - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "updated_at": { - "type": "string", - "nullable": true, - "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", - "nullable": true - }, - "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", - "nullable": true, - "format": "date-time" - }, - "reactions": { - "title": "Reactions", + "package_version": { "type": "object", "properties": { - "+1": { - "type": "integer" + "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" + ] }, - "-1": { - "type": "integer" + "body": { + "type": "string" }, - "confused": { - "type": "integer" + "body_html": { + "type": "string" }, - "eyes": { - "type": "integer" + "created_at": { + "type": "string" }, - "heart": { - "type": "integer" + "description": { + "type": "string" }, - "hooray": { - "type": "integer" + "docker_metadata": { + "type": "array", + "items": { + "type": "object", + "nullable": true, + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } }, - "laugh": { - "type": "integer" + "draft": { + "type": "boolean" }, - "rocket": { - "type": "integer" + "html_url": { + "type": "string" }, - "total_count": { + "id": { "type": "integer" }, - "url": { - "type": "string", - "format": "uri" + "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", + "nullable": true + }, + "name": { + "type": "string" + }, + "sha1": { + "type": "string", + "nullable": true + }, + "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": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "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" ] }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "tarball_url": { - "type": "string", - "nullable": true, - "format": "uri" + "registry": { + "type": "object", + "nullable": true }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", + "updated_at": { "type": "string" - }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, - "url": { - "type": "string", - "format": "uri" - }, - "zipball_url": { - "type": "string", - "nullable": true, - "format": "uri" } }, "required": [ - "url", - "assets_url", - "upload_url", - "html_url", "id", - "node_id", - "tag_name", - "target_commitish", "name", - "draft", - "author", - "prerelease", - "immutable", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", "created_at", - "published_at", - "assets", - "tarball_url", "updated_at", - "zipball_url", - "body" + "owner", + "package_version", + "registry" ] }, "repository": { @@ -1304988,9 +1304073,8 @@ }, "required": [ "action", - "changes", - "release", - "repository" + "registry_package", + "sender" ] } } @@ -1305004,7 +1304088,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -1305013,11 +1304097,11 @@ } } }, - "release-prereleased": { + "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 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": "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" }, @@ -1305084,13 +1304168,13 @@ "content": { "application/json": { "schema": { - "title": "release prereleased event", + "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "prereleased" + "created" ] }, "enterprise": { @@ -1305259,28 +1304343,6 @@ "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", @@ -1305288,22 +1304350,6 @@ "title": "Release Asset", "description": "Data related to a release.", "type": "object", - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ], - "nullable": true, "properties": { "browser_download_url": { "type": "string", @@ -1305355,10 +1304401,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1305441,13 +1304483,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": { @@ -1305458,10 +1304519,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1305547,7 +1304604,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": "string", @@ -1305558,6 +1304619,11 @@ "nullable": true, "format": "date-time" }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1305586,10 +1304652,7 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean", - "enum": [ - true - ] + "type": "boolean" }, "published_at": { "type": "string", @@ -1305599,18 +1304662,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1305643,7 +1304694,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.", @@ -1305662,11 +1304725,6 @@ "type": "string", "format": "uri-template" }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, "url": { "type": "string", "format": "uri" @@ -1305676,7 +1304734,29 @@ "nullable": true, "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", @@ -1307025,7 +1306105,8 @@ "required": [ "action", "release", - "repository" + "repository", + "sender" ] } } @@ -1307048,11 +1306129,11 @@ } } }, - "release-published": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "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" }, @@ -1307119,13 +1306200,13 @@ "content": { "application/json": { "schema": { - "title": "release published event", + "title": "release deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "deleted" ] }, "enterprise": { @@ -1307294,28 +1306375,6 @@ "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", @@ -1307323,22 +1306382,6 @@ "title": "Release Asset", "description": "Data related to a release.", "type": "object", - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "content_type", - "size", - "digest", - "download_count", - "created_at", - "updated_at" - ], - "nullable": true, "properties": { "browser_download_url": { "type": "string", @@ -1307390,10 +1306433,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1307476,13 +1306515,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": { @@ -1307493,10 +1306551,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1307582,7 +1306636,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": "string", @@ -1307593,6 +1306651,11 @@ "nullable": true, "format": "date-time" }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1307631,18 +1306694,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1307675,7 +1306726,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.", @@ -1307690,11 +1306753,6 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, "upload_url": { "type": "string", "format": "uri-template" @@ -1307708,7 +1306766,29 @@ "nullable": true, "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", @@ -1309057,7 +1308137,8 @@ "required": [ "action", "release", - "repository" + "repository", + "sender" ] } } @@ -1309080,11 +1308161,11 @@ } } }, - "release-released": { + "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 published, or a pre-release was changed to a release.", - "operationId": "release/released", + "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" }, @@ -1309151,15 +1308232,68 @@ "content": { "application/json": { "schema": { - "title": "release released event", + "title": "release edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "released" + "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).\"", @@ -1311087,6 +1310221,7 @@ }, "required": [ "action", + "changes", "release", "repository" ] @@ -1311111,11 +1310246,11 @@ } } }, - "release-unpublished": { + "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 or pre-release was unpublished.", - "operationId": "release/unpublished", + "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" }, @@ -1311182,13 +1310317,13 @@ "content": { "application/json": { "schema": { - "title": "release unpublished event", + "title": "release prereleased event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unpublished" + "prereleased" ] }, "enterprise": { @@ -1311366,10 +1310501,10 @@ "draft", "html_url", "id", + "immutable", "name", "node_id", "prerelease", - "immutable", "published_at", "tag_name", "tarball_url", @@ -1311394,9 +1310529,9 @@ "name", "label", "state", + "digest", "content_type", "size", - "digest", "download_count", "created_at", "updated_at" @@ -1311684,7 +1310819,10 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" + "type": "boolean", + "enum": [ + true + ] }, "published_at": { "type": "string", @@ -1311753,15 +1310891,15 @@ "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", "nullable": true, "format": "date-time" }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, "url": { "type": "string", "format": "uri" @@ -1313143,13 +1312281,13 @@ } } }, - "repository-advisory-published": { + "release-published": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A 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, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1313171,7 +1312309,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -1313214,7 +1312352,7 @@ "content": { "application/json": { "schema": { - "title": "Repository advisory published event", + "title": "release published event", "type": "object", "properties": { "action": { @@ -1313385,6 +1312523,426 @@ "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", + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], + "nullable": true, + "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", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "body": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": "string", + "nullable": true, + "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.", @@ -1314604,1560 +1314162,6 @@ "updated_at" ] }, - "repository_advisory": { - "description": "A repository security advisory.", - "type": "object", - "properties": { - "ghsa_id": { - "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true - }, - "cve_id": { - "type": "string", - "description": "The Common Vulnerabilities and Exposures (CVE) ID.", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL for the advisory.", - "readOnly": true - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535, - "nullable": true - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "nullable": true, - "enum": [ - "critical", - "high", - "medium", - "low" - ] - }, - "author": { - "readOnly": true, - "nullable": true, - "description": "The author of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "publisher": { - "readOnly": true, - "nullable": true, - "description": "The publisher of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "identifiers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } - }, - "required": [ - "type", - "value" - ] - }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "published_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "closed_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "withdrawn_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "submission": { - "type": "object", - "nullable": true, - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true - } - }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": "array", - "nullable": true, - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": "object", - "nullable": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "nullable": true - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "The range of the package versions affected by the vulnerability.", - "nullable": true - }, - "patched_versions": { - "type": "string", - "description": "The package version(s) that resolve the vulnerability.", - "nullable": true - }, - "vulnerable_functions": { - "type": "array", - "description": "The functions in the package that are affected.", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" - ], - "additionalProperties": false - } - }, - "cvss_severities": { - "type": "object", - "nullable": true, - "properties": { - "cvss_v3": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 3 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 4 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "cwes": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - }, - "readOnly": true - }, - "cwe_ids": { - "type": "array", - "description": "A list of only the CWE IDs.", - "nullable": true, - "items": { - "type": "string" - } - }, - "credits": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - } - } - }, - "credits_detailed": { - "type": "array", - "nullable": true, - "items": { - "description": "A credit given to a user for a repository security advisory.", - "type": "object", - "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" - ] - } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false - }, - "readOnly": true - }, - "collaborating_users": { - "type": "array", - "description": "A list of users that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "collaborating_teams": { - "type": "array", - "description": "A list of teams that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "access_source": { - "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", - "type": "string", - "enum": [ - "direct", - "organization", - "enterprise" - ], - "example": "direct" - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "private_fork": { - "readOnly": true, - "nullable": true, - "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", - "allOf": [ - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the 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" - ] - } - ] - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ], - "additionalProperties": false - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -1316285,8 +1314289,8 @@ }, "required": [ "action", - "repository", - "repository_advisory" + "release", + "repository" ] } } @@ -1316300,7 +1314304,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -1316309,13 +1314313,13 @@ } } }, - "repository-advisory-reported": { + "release-released": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A private vulnerability report was submitted.", - "operationId": "repository-advisory/reported", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1316337,7 +1314341,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -1316380,13 +1314384,13 @@ "content": { "application/json": { "schema": { - "title": "Repository advisory reported event", + "title": "release released event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reported" + "released" ] }, "enterprise": { @@ -1316551,6 +1314555,425 @@ "description" ] }, + "release": { + "title": "Release", + "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "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", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "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" + }, + "author": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "updated_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "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" + ] + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string" + }, + "tarball_url": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "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.", @@ -1317770,1612 +1316193,58 @@ "updated_at" ] }, - "repository_advisory": { - "description": "A repository security advisory.", + "sender": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "ghsa_id": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true + "example": "octocat" }, - "cve_id": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { "type": "string", - "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", - "description": "The API URL for the advisory.", - "readOnly": true + "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true + "example": "https://github.com/octocat" }, - "summary": { + "followers_url": { "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "description": { - "type": "string", - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535, - "nullable": true - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "nullable": true, - "enum": [ - "critical", - "high", - "medium", - "low" - ] - }, - "author": { - "readOnly": true, - "nullable": true, - "description": "The author of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "publisher": { - "readOnly": true, - "nullable": true, - "description": "The publisher of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "identifiers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } - }, - "required": [ - "type", - "value" - ] - }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "published_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "closed_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "withdrawn_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "submission": { - "type": "object", - "nullable": true, - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true - } - }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": "array", - "nullable": true, - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": "object", - "nullable": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "nullable": true - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "The range of the package versions affected by the vulnerability.", - "nullable": true - }, - "patched_versions": { - "type": "string", - "description": "The package version(s) that resolve the vulnerability.", - "nullable": true - }, - "vulnerable_functions": { - "type": "array", - "description": "The functions in the package that are affected.", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" - ], - "additionalProperties": false - } - }, - "cvss_severities": { - "type": "object", - "nullable": true, - "properties": { - "cvss_v3": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 3 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 4 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "cwes": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - }, - "readOnly": true - }, - "cwe_ids": { - "type": "array", - "description": "A list of only the CWE IDs.", - "nullable": true, - "items": { - "type": "string" - } - }, - "credits": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - } - } - }, - "credits_detailed": { - "type": "array", - "nullable": true, - "items": { - "description": "A credit given to a user for a repository security advisory.", - "type": "object", - "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" - ] - } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false - }, - "readOnly": true - }, - "collaborating_users": { - "type": "array", - "description": "A list of users that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "collaborating_teams": { - "type": "array", - "description": "A list of teams that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "access_source": { - "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", - "type": "string", - "enum": [ - "direct", - "organization", - "enterprise" - ], - "example": "direct" - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "private_fork": { - "readOnly": true, - "nullable": true, - "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", - "allOf": [ - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the 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" - ] - } - ] - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ], - "additionalProperties": false - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { + "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, @@ -1319451,8 +1316320,8 @@ }, "required": [ "action", - "repository", - "repository_advisory" + "release", + "repository" ] } } @@ -1319466,7 +1316335,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -1319475,13 +1316344,13 @@ } } }, - "repository-archived": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was archived.", - "operationId": "repository/archived", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1319503,7 +1316372,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "release", "schema": { "type": "string" } @@ -1319546,13 +1316415,13 @@ "content": { "application/json": { "schema": { - "title": "repository archived event", + "title": "release unpublished event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "archived" + "unpublished" ] }, "enterprise": { @@ -1319717,6 +1316586,426 @@ "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", + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], + "nullable": true, + "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", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "body": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": "string", + "nullable": true, + "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.", @@ -1321063,8 +1318352,8 @@ }, "required": [ "action", - "repository", - "sender" + "release", + "repository" ] } } @@ -1321078,9 +1318367,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -1321088,13 +1318376,13 @@ } } }, - "repository-created": { + "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was created.", - "operationId": "repository/created", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -1321116,7 +1318404,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_advisory", "schema": { "type": "string" } @@ -1321159,13 +1318447,13 @@ "content": { "application/json": { "schema": { - "title": "repository created event", + "title": "Repository advisory published event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "published" ] }, "enterprise": { @@ -1322549,14 +1319837,1568 @@ "updated_at" ] }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", + "repository_advisory": { + "description": "A repository security advisory.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535, + "nullable": true + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "nullable": true, + "enum": [ + "critical", + "high", + "medium", + "low" + ] + }, + "author": { + "readOnly": true, + "nullable": true, + "description": "The author of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "publisher": { + "readOnly": true, + "nullable": true, + "description": "The publisher of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "closed_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "withdrawn_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "submission": { + "type": "object", + "nullable": true, + "readOnly": true, + "properties": { + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true + } + }, + "required": [ + "accepted" + ] + }, + "vulnerabilities": { + "type": "array", + "nullable": true, + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "patched_versions": { + "type": "string", + "description": "The package version(s) that resolve the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected.", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss_severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "cwes": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": "array", + "description": "A list of only the CWE IDs.", + "nullable": true, + "items": { + "type": "string" + } + }, + "credits": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + } + } + }, + "credits_detailed": { + "type": "array", + "nullable": true, + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "state": { + "type": "string", + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" + ] + } + }, + "required": [ + "user", + "type", + "state" + ], + "additionalProperties": false + }, + "readOnly": true + }, + "collaborating_users": { + "type": "array", + "description": "A list of users that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "collaborating_teams": { + "type": "array", + "description": "A list of teams that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "access_source": { + "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", + "type": "string", + "enum": [ + "direct", + "organization", + "enterprise" + ], + "example": "direct" + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + } + }, + "private_fork": { + "readOnly": true, + "nullable": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the 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" + ] + } + ] + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ], + "additionalProperties": false + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, "email": { "nullable": true, @@ -1322677,7 +1321519,7 @@ "required": [ "action", "repository", - "sender" + "repository_advisory" ] } } @@ -1322691,9 +1321533,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -1322701,13 +1321542,13 @@ } } }, - "repository-deleted": { + "repository-advisory-reported": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", - "operationId": "repository/deleted", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -1322729,7 +1321570,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_advisory", "schema": { "type": "string" } @@ -1322772,13 +1321613,13 @@ "content": { "application/json": { "schema": { - "title": "repository deleted event", + "title": "Repository advisory reported event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "reported" ] }, "enterprise": { @@ -1324162,173 +1323003,1727 @@ "updated_at" ] }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", + "repository_advisory": { + "description": "A repository security advisory.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { + "ghsa_id": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "description": "The GitHub Security Advisory ID.", + "readOnly": true }, - "gravatar_id": { + "cve_id": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", "nullable": true }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "description": "The API URL for the advisory.", + "readOnly": true }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat" + "description": "The URL for the advisory.", + "readOnly": true }, - "followers_url": { + "summary": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "description": "A short summary of the advisory.", + "maxLength": 1024 }, - "following_url": { + "description": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535, + "nullable": true }, - "gists_url": { + "severity": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "description": "The severity of the advisory.", + "nullable": true, + "enum": [ + "critical", + "high", + "medium", + "low" + ] }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "author": { + "readOnly": true, + "nullable": true, + "description": "The author of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "publisher": { + "readOnly": true, + "nullable": true, + "description": "The publisher of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true }, - "repos_url": { + "state": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" + ] }, - "events_url": { + "created_at": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true, + "nullable": true }, - "received_events_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true, + "nullable": true }, - "type": { + "published_at": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true, + "nullable": true }, - "starred_at": { + "closed_at": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true, + "nullable": true }, - "user_view_type": { + "withdrawn_at": { "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "action", - "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-dispatch-sample.collected": { - "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "submission": { + "type": "object", + "nullable": true, + "readOnly": true, + "properties": { + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true + } + }, + "required": [ + "accepted" + ] + }, + "vulnerabilities": { + "type": "array", + "nullable": true, + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "patched_versions": { + "type": "string", + "description": "The package version(s) that resolve the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected.", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss_severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "cwes": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": "array", + "description": "A list of only the CWE IDs.", + "nullable": true, + "items": { + "type": "string" + } + }, + "credits": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + } + } + }, + "credits_detailed": { + "type": "array", + "nullable": true, + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "state": { + "type": "string", + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" + ] + } + }, + "required": [ + "user", + "type", + "state" + ], + "additionalProperties": false + }, + "readOnly": true + }, + "collaborating_users": { + "type": "array", + "description": "A list of users that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "collaborating_teams": { + "type": "array", + "description": "A list of teams that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "access_source": { + "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", + "type": "string", + "enum": [ + "direct", + "organization", + "enterprise" + ], + "example": "direct" + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + } + }, + "private_fork": { + "readOnly": true, + "nullable": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the 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" + ] + } + ] + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ], + "additionalProperties": false + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "repository_advisory" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_advisory", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-archived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was archived.", + "operationId": "repository/archived", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, { "name": "X-Github-Hook-Id", @@ -1324341,7 +1324736,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_dispatch", + "example": "repository", "schema": { "type": "string" } @@ -1324384,21 +1324779,14 @@ "content": { "application/json": { "schema": { - "title": "repository_dispatch event", + "title": "repository archived event", "type": "object", "properties": { "action": { "type": "string", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." - }, - "branch": { - "type": "string" - }, - "client_payload": { - "type": "object", - "nullable": true, - "additionalProperties": true, - "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + "enum": [ + "archived" + ] }, "enterprise": { "title": "Enterprise", @@ -1325908,11 +1326296,8 @@ }, "required": [ "action", - "branch", - "client_payload", "repository", - "sender", - "installation" + "sender" ] } } @@ -1325926,18 +1326311,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "repository-created": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The topics, default branch, description, or homepage of a repository was changed.", - "operationId": "repository/edited", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -1326004,67 +1326392,15 @@ "content": { "application/json": { "schema": { - "title": "repository edited event", + "title": "repository created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "created" ] }, - "changes": { - "type": "object", - "properties": { - "default_branch": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "description": { - "type": "object", - "properties": { - "from": { - "type": "string", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "homepage": { - "type": "object", - "properties": { - "from": { - "type": "string", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "topics": { - "type": "object", - "properties": { - "from": { - "type": "array", - "nullable": true, - "items": { - "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).\"", @@ -1327573,7 +1327909,6 @@ }, "required": [ "action", - "changes", "repository", "sender" ] @@ -1327599,12 +1327934,13 @@ } } }, - "repository-import": { + "repository-deleted": { "post": { - "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", - "operationId": "repository-import", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1327626,7 +1327962,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_import", + "example": "repository", "schema": { "type": "string" } @@ -1327669,9 +1328005,15 @@ "content": { "application/json": { "schema": { - "title": "repository_import event", + "title": "repository deleted event", "type": "object", "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, "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).\"", @@ -1329176,18 +1329518,10 @@ "type", "url" ] - }, - "status": { - "type": "string", - "enum": [ - "success", - "cancelled", - "failure" - ] } }, "required": [ - "status", + "action", "repository", "sender" ] @@ -1329203,21 +1329537,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-privatized": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -1329239,7 +1329574,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_dispatch", "schema": { "type": "string" } @@ -1329282,14 +1329617,21 @@ "content": { "application/json": { "schema": { - "title": "repository privatized event", + "title": "repository_dispatch event", "type": "object", "properties": { "action": { "type": "string", - "enum": [ - "privatized" - ] + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, + "branch": { + "type": "string" + }, + "client_payload": { + "type": "object", + "nullable": true, + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "title": "Enterprise", @@ -1330799,8 +1331141,11 @@ }, "required": [ "action", + "branch", + "client_payload", "repository", - "sender" + "sender", + "installation" ] } } @@ -1330814,21 +1331159,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "repository-publicized": { + "repository-edited": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -1330895,15 +1331237,67 @@ "content": { "application/json": { "schema": { - "title": "repository publicized event", + "title": "repository edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicized" + "edited" ] }, + "changes": { + "type": "object", + "properties": { + "default_branch": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "description": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "homepage": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "topics": { + "type": "object", + "properties": { + "from": { + "type": "array", + "nullable": true, + "items": { + "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).\"", @@ -1332412,6 +1332806,7 @@ }, "required": [ "action", + "changes", "repository", "sender" ] @@ -1332437,13 +1332832,12 @@ } } }, - "repository-renamed": { + "repository-import": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -1332465,7 +1332859,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_import", "schema": { "type": "string" } @@ -1332508,42 +1332902,9 @@ "content": { "application/json": { "schema": { - "title": "repository renamed event", + "title": "repository_import event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "renamed" - ] - }, - "changes": { - "type": "object", - "properties": { - "repository": { - "type": "object", - "properties": { - "name": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "name" - ] - } - }, - "required": [ - "repository" - ] - }, "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).\"", @@ -1334048,11 +1334409,18 @@ "type", "url" ] + }, + "status": { + "type": "string", + "enum": [ + "success", + "cancelled", + "failure" + ] } }, "required": [ - "action", - "changes", + "status", "repository", "sender" ] @@ -1334068,23 +1334436,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_import", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-ruleset-created": { + "repository-privatized": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1334106,7 +1334472,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -1334149,13 +1334515,13 @@ "content": { "application/json": { "schema": { - "title": "repository ruleset created event", + "title": "repository privatized event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "privatized" ] }, "enterprise": { @@ -1335539,1338 +1335905,6 @@ "updated_at" ] }, - "repository_ruleset": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": "integer", - "nullable": true, - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey", - "User" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", - "enum": [ - "always", - "pull_request", - "exempt" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never", - "exempt" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": "object", - "nullable": true, - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "nullable": true, - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ] - }, - "rules": { - "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." - }, - "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" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -1336998,7 +1336032,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1337013,8 +1336047,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1337022,13 +1336057,13 @@ } } }, - "repository-ruleset-deleted": { + "repository-publicized": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1337050,7 +1336085,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -1337093,13 +1336128,13 @@ "content": { "application/json": { "schema": { - "title": "repository ruleset deleted event", + "title": "repository publicized event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "publicized" ] }, "enterprise": { @@ -1338483,1338 +1337518,6 @@ "updated_at" ] }, - "repository_ruleset": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": "integer", - "nullable": true, - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey", - "User" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", - "enum": [ - "always", - "pull_request", - "exempt" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never", - "exempt" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": "object", - "nullable": true, - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "nullable": true, - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ] - }, - "rules": { - "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." - }, - "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" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -1339942,7 +1337645,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1339957,8 +1337660,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1339966,13 +1337670,13 @@ } } }, - "repository-ruleset-edited": { + "repository-renamed": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1339994,7 +1337698,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -1340037,13 +1337741,1654 @@ "content": { "application/json": { "schema": { - "title": "repository ruleset edited event", + "title": "repository renamed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "renamed" + ] + }, + "changes": { + "type": "object", + "properties": { + "repository": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "repository" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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-ruleset-created": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "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_ruleset", + "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 ruleset created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" ] }, "enterprise": { @@ -1342071,6 +1341416,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." @@ -1342759,2959 +1342147,12474 @@ } } }, - "changes": { + "sender": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { "name": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } + "nullable": true, + "type": "string" }, - "enforcement": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } + "email": { + "nullable": true, + "type": "string" }, - "conditions": { - "type": "object", - "properties": { - "added": { - "type": "array", - "items": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "deleted": { - "type": "array", - "items": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "updated": { - "type": "array", - "items": { - "type": "object", - "properties": { - "condition": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - "changes": { - "type": "object", - "properties": { - "condition_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "target": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "include": { - "type": "object", - "properties": { - "from": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "exclude": { - "type": "object", - "properties": { - "from": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - } - } - } + "login": { + "type": "string", + "example": "octocat" }, - "rules": { - "type": "object", - "properties": { - "added": { - "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." - }, - "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" - ] + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-ruleset-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "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_ruleset", + "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 ruleset deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "repository_ruleset": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": "integer", + "nullable": true, + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "User" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", + "enum": [ + "always", + "pull_request", + "exempt" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never", + "exempt" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": "object", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } } } - }, - "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" - ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } }, - "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" - ] + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } } - }, - "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": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] } - }, - { - "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" - ] + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } } - } - }, - { - "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." + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } } - }, - "required": [ - "operator", - "pattern" - ] - } + } + }, + "required": [ + "repository_property" + ] } + ] + } + ] + } + ] + }, + "rules": { + "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" + ] }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", + "parameters": { "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" - ] + "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" + ] }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "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": [ - "committer_email_pattern" + "ALLGREEN", + "HEADGREEN" ] }, - "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": { + "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": [ - "branch_name_pattern" + "MERGE", + "SQUASH", + "REBASE" ] }, - "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" - ] + "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" + ] }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", + "parameters": { "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" - ] + "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" + ] }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] + "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" + ] + } }, - "parameters": { + "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": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { + "allowed_actors": { "type": "array", - "description": "Workflows that must pass for this rule to pass.", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", "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": { + "id": { "type": "integer", - "description": "The ID of the repository where the workflow is defined" + "description": "ID of the actor that can dismiss reviews." }, - "sha": { + "type": { "type": "string", - "description": "The commit SHA of the workflow file to use" + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] } }, "required": [ - "path", - "repository_id" + "id", + "type" ] } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." } }, "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" + "enabled" ] }, - "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.", + "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": { - "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" - ] + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." }, - "security_alerts_threshold": { + "type": { "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).\"", + "description": "The type of the reviewer", "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" + "Team" ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" } }, "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" + "id", + "type" ] } - } - }, - "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." - } + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] } } - } - }, - { - "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" - ] - } - } + "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" + ] }, - { - "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.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." }, - "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_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": [ - "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" - ] + }, + "required": [ + "context" + ] + } }, - "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" - ] + "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" + ] }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "file_extension_restriction" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "max_file_size" + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "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" - ] + "pattern": { + "type": "string", + "description": "The pattern to match with." } - } + }, + "required": [ + "operator", + "pattern" + ] } - ] - } - }, - "deleted": { - "type": "array", - "items": { - "title": "Repository Rule", + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern 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" - ] - } - } + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "update" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "deletion" + "starts_with", + "ends_with", + "contains", + "regex" ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "pattern": { "type": "string", - "enum": [ - "required_linear_history" - ] + "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" + ] }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "merge_queue" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "required_deployments" + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "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": { + "pattern": { "type": "string", - "enum": [ - "required_signatures" - ] + "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" + ] }, - { - "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.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "pull_request" - ] + "description": "How this rule appears when configuring it." }, - "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." - }, - "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": { + "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": [ - "required_status_checks" + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "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": { + "pattern": { "type": "string", - "enum": [ - "non_fast_forward" - ] + "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" + ] }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "commit_message_pattern" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "commit_author_email_pattern" + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "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" - ] + "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" + ] }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." }, - "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" - ] + "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" + } }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] + "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" + ] }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", + "parameters": { "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" - ] + "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" + } }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] + "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" + ] }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." }, - "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" - ] + "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" + ] }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "parameters": { "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" - ] + "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" + ] }, - { - "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.", + "parameters": { "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" - ] + "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" + ] }, - { - "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.", + "parameters": { "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." - } + "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" + ] }, - { - "title": "license_compliance_scanning", - "description": "Enforce any added or changed dependencies to comply with the organization's license policy.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "license_compliance_scanning" - ] + "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 } - } - }, - { - "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" - ] + "max_file_size" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-ruleset-edited": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "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_ruleset", + "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 ruleset edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "repository_ruleset": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": "integer", + "nullable": true, + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "User" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", + "enum": [ + "always", + "pull_request", + "exempt" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never", + "exempt" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": "object", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" } } - }, - { - "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 + } + } + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } } - }, - "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" - ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } }, - "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": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "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" - ] + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } }, - "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": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } } - }, - "required": [ - "max_file_size" - ] + } } - } - } - ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + } + ] + } + ] + } + ] + }, + "rules": { + "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" + ] + }, + "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" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "changes": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "enforcement": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "conditions": { + "type": "object", + "properties": { + "added": { + "type": "array", + "items": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "deleted": { + "type": "array", + "items": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "condition": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + "changes": { + "type": "object", + "properties": { + "condition_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "target": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "include": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "exclude": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "rules": { + "type": "object", + "properties": { + "added": { + "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" + ] + }, + "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" + ] + }, + "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" + ] + } + } + } + ] + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "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" + ] + }, + "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" + ] + } + } + } + ] + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", + "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 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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + } + } + }, + "required": [ + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } } }, - "updated": { + "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": "object", - "properties": { - "rule": { - "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." - }, - "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" - ] - } - } - } - ] - }, - "changes": { - "type": "object", - "properties": { - "configuration": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "rule_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "pattern": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - } - } - } + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] }, "sender": { "title": "Simple User", @@ -1345840,7 +1354743,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1345855,8 +1354758,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1345864,13 +1354768,13 @@ } } }, - "repository-transferred": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to 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" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1345892,7 +1354796,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -1345935,200 +1354839,181 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "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": { + "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", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "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", @@ -1347638,7 +1356523,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1347654,23 +1356539,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": [ { @@ -1347692,7 +1356575,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -1347735,15 +1356618,191 @@ "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", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "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).\"", @@ -1349252,6 +1358311,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1349267,21 +1358327,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" }, @@ -1349348,13 +1358406,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": { @@ -1351056,11 +1360114,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" }, @@ -1351127,13 +1360185,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": { @@ -1351144,9 +1360202,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1351166,10 +1360221,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1351265,9 +1360316,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1351307,7 +1360355,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1352816,280 +1361865,1022 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "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_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "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 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" - }, - "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 reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": "string", - "nullable": true, - "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": [ + "action", + "alert", + "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_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "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 assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "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, + "nullable": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "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": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "description": "The slug identifier for the provider of the secret that was detected.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true + }, + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true + }, + "closure_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1354600,8 +1364391,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1354615,21 +1364405,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": [ { @@ -1354651,7 +1364442,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1354694,179 +1364485,797 @@ "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": { + "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, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "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": "string", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "description": "The slug identifier for the provider of the secret that was detected.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "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" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fix_reason": { - "type": "string" + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "fixed_in": { - "type": "string" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "ghsa_id": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "id": { - "type": "integer" + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "node_id": { - "type": "string" + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true }, - "number": { - "type": "integer" + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true }, - "severity": { - "type": "string" + "closure_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "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" + ] + } } } }, @@ -1356379,8 +1366788,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1356394,21 +1366802,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": [ { @@ -1356430,7 +1366839,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "secret_scanning_alert_location", "schema": { "type": "string" } @@ -1356473,13 +1366882,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": { @@ -1357242,200 +1367651,30 @@ "url" ], "nullable": true - } - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" + "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" + ] + } } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] + } }, "installation": { "title": "Simple Installation", @@ -1357458,6 +1367697,368 @@ "node_id" ] }, + "location": { + "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.", + "example": "commit" + }, + "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", + "example": "/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", + "example": "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", + "example": "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.", + "example": "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", + "example": "/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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "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.", @@ -1358876,10 +1369477,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" + } + } } } } @@ -1358891,8 +1369667,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1358901,11 +1369678,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" }, @@ -1358972,13 +1369749,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": { @@ -1359741,6 +1370518,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1361265,7 +1372064,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -1361276,13 +1372074,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": [ { @@ -1361304,7 +1372102,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert_location", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1361347,13 +1372145,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": { @@ -1362116,9 +1372914,99 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1362140,368 +1373028,6 @@ "node_id" ] }, - "location": { - "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.", - "example": "commit" - }, - "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", - "example": "/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", - "example": "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", - "example": "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.", - "example": "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", - "example": "/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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - }, "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.", @@ -1363920,185 +1374446,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" - } - } } } } @@ -1364109,10 +1374460,8 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1364961,6 +1375310,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1367336,6 +1377707,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1369711,6 +1380104,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1372086,6 +1382501,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1374585,6 +1385022,28 @@ "url" ], "nullable": true + }, + "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/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index fef4112664..61fff8f815 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -1001,7 +1001,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &697 + - &699 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -14028,7 +14028,7 @@ paths: properties: action: type: string - discussion: &793 + discussion: &795 title: Discussion description: A Discussion in a repository. type: object @@ -14766,7 +14766,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &708 + sub_issues_summary: &710 title: Sub-issues Summary type: object properties: @@ -14893,7 +14893,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &709 + issue_dependencies_summary: &711 title: Issue Dependencies Summary type: object properties: @@ -22005,7 +22005,7 @@ paths: parameters: - *78 - *124 - - &769 + - &771 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 @@ -22117,7 +22117,7 @@ paths: - *124 - *125 - *126 - - &770 + - &772 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -22125,7 +22125,7 @@ paths: schema: type: string - *129 - - &771 + - &773 name: sku description: The SKU to query for usage. in: query @@ -29629,12 +29629,12 @@ paths: required: - subject_digests examples: - default: &750 + default: &752 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &751 + withPredicateType: &753 value: subject_digests: - sha256:abc123 @@ -29678,7 +29678,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &752 + default: &754 value: attestations_subject_digests: - sha256:abc: @@ -41697,7 +41697,7 @@ paths: parameters: - *78 - *269 - - &732 + - &734 name: repo_name description: repo_name parameter in: path @@ -42625,7 +42625,7 @@ paths: - nuget - container - *78 - - &733 + - &735 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -42666,7 +42666,7 @@ paths: default: *276 '403': *29 '401': *25 - '400': &735 + '400': &737 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -44874,7 +44874,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &824 + properties: &826 id: type: number description: The unique identifier of the status update. @@ -44922,7 +44922,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &825 + required: &827 - id - node_id - created_at @@ -45727,7 +45727,7 @@ paths: - updated_at - project_url examples: - default: &756 + default: &758 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -45904,7 +45904,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &757 + items: &759 type: object properties: name: @@ -45941,7 +45941,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &758 + iteration_configuration: &760 type: object description: The configuration for iteration fields. properties: @@ -45991,7 +45991,7 @@ paths: value: name: Due date data_type: date - single_select_field: &759 + single_select_field: &761 summary: Create a single select field value: name: Priority @@ -46018,7 +46018,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &760 + iteration_field: &762 summary: Create an iteration field value: name: Sprint @@ -46044,7 +46044,7 @@ paths: application/json: schema: *297 examples: - text_field: &761 + text_field: &763 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -46053,7 +46053,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: &762 + number_field: &764 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -46062,7 +46062,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: &763 + date_field: &765 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -46071,7 +46071,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: &764 + single_select_field: &766 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46105,7 +46105,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &765 + iteration_field: &767 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -46151,7 +46151,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *293 - - &766 + - &768 name: field_id description: The unique identifier of the field. in: path @@ -46166,7 +46166,7 @@ paths: application/json: schema: *297 examples: - default: &767 + default: &769 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47363,7 +47363,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &747 + schema: &749 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -47540,7 +47540,7 @@ paths: parameters: - *293 - *78 - - &768 + - &770 name: view_number description: The number that identifies the project view. in: path @@ -49990,6 +49990,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 @@ -51583,6 +51620,29 @@ paths: required: false schema: type: boolean + - &675 + 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 + - &676 + 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 @@ -51609,14 +51669,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &675 + state: &677 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: &676 + resolution: &678 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -51733,8 +51793,8 @@ paths: pull request. ' - oneOf: &677 - - &679 + oneOf: &679 + - &681 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -51792,7 +51852,7 @@ paths: - blob_url - commit_sha - commit_url - - &680 + - &682 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. @@ -51847,7 +51907,7 @@ paths: - page_url - commit_sha - commit_url - - &681 + - &683 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -51867,7 +51927,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &682 + - &684 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -51887,7 +51947,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &683 + - &685 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -51907,7 +51967,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &684 + - &686 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -51921,7 +51981,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &685 + - &687 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -51935,7 +51995,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &686 + - &688 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -51949,7 +52009,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &687 + - &689 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. @@ -51969,7 +52029,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &688 + - &690 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. @@ -51989,7 +52049,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &689 + - &691 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. @@ -52009,7 +52069,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &690 + - &692 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. @@ -52029,7 +52089,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &691 + - &693 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. @@ -52548,7 +52608,7 @@ paths: application/json: schema: type: array - items: &695 + items: &697 description: A repository security advisory. type: object properties: @@ -52820,7 +52880,7 @@ paths: - private_fork additionalProperties: false examples: - default: &696 + default: &698 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -54665,7 +54725,7 @@ paths: application/json: schema: type: array - items: &711 + items: &713 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 @@ -54784,7 +54844,7 @@ paths: - type - url examples: - default: &712 + default: &714 value: - login: octocat id: 1 @@ -54870,7 +54930,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &713 + response-if-user-is-a-team-maintainer: &715 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -54935,7 +54995,7 @@ paths: application/json: schema: *353 examples: - response-if-users-membership-with-team-is-now-pending: &714 + response-if-users-membership-with-team-is-now-pending: &716 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -55049,7 +55109,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &715 + schema: &717 title: Team Repository description: A team's access to a repository. type: object @@ -55699,7 +55759,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: &716 + response-if-child-teams-exist: &718 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -61344,7 +61404,7 @@ paths: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &787 + properties: &789 url: type: string format: uri @@ -61429,7 +61489,7 @@ paths: nullable: true properties: *83 required: *84 - required: &788 + required: &790 - id - node_id - sha @@ -67501,7 +67561,7 @@ paths: check. type: array items: *93 - deployment: &780 + deployment: &782 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -68413,7 +68473,7 @@ paths: type: string format: date-time nullable: true - head_commit: &808 + head_commit: &810 title: Simple Commit description: A commit. type: object @@ -73137,14 +73197,14 @@ paths: type: integer machines: type: array - items: &721 + items: &723 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *477 required: *478 examples: - default: &722 + default: &724 value: total_count: 2 machines: @@ -76290,7 +76350,7 @@ paths: application/json: schema: type: array - items: &700 + items: &702 title: Status description: The status of a commit. type: object @@ -77873,7 +77933,7 @@ paths: items: type: object properties: - placeholder_id: &692 + placeholder_id: &694 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -83933,7 +83993,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &816 + last_response: &818 title: Hook Response type: object properties: @@ -84985,7 +85045,7 @@ paths: parameters: - *354 - *355 - - &745 + - &747 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -85570,7 +85630,7 @@ paths: type: array items: *556 examples: - default: &737 + default: &739 value: - id: 1 repository: @@ -100503,6 +100563,8 @@ paths: - *672 - *673 - *674 + - *675 + - *676 responses: '200': description: Response @@ -100510,7 +100572,7 @@ paths: application/json: schema: type: array - items: &678 + items: type: object properties: number: *188 @@ -100529,8 +100591,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *675 - resolution: *676 + state: *677 + resolution: *678 resolved_at: type: string format: date-time @@ -100636,7 +100698,7 @@ paths: pull request. ' - oneOf: *677 + oneOf: *679 nullable: true has_more_locations: type: boolean @@ -100809,7 +100871,176 @@ paths: description: Response content: application/json: - schema: *678 + schema: &680 + type: object + properties: + number: *188 + created_at: *189 + updated_at: + 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 + nullable: true + url: *191 + html_url: *192 + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: *677 + resolution: *678 + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + resolution_comment: + type: string + description: An optional comment to resolve an alert. + nullable: true + 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 + description: The provider of the secret that was detected. + nullable: true + provider_slug: + type: string + 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. + nullable: true + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected + secret. + nullable: true + push_protection_bypassed_by: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO + 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection + bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the detected secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple + repositories under the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert + is base64 encoded + nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: *679 + nullable: true + 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: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + closure_request_comment: + type: string + description: An optional comment from the closure request author. + nullable: true + closure_request_reviewer_comment: + type: string + description: An optional comment from the closure request reviewer. + nullable: true + closure_request_reviewer: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + metadata: &839 + 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: @@ -100836,6 +101067,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com '304': *37 '404': description: Repository is public, or secret scanning is disabled for the @@ -100873,8 +101107,8 @@ paths: schema: type: object properties: - state: *675 - resolution: *676 + state: *677 + resolution: *678 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -100918,7 +101152,7 @@ paths: description: Response content: application/json: - schema: *678 + schema: *680 examples: default: value: @@ -100963,6 +101197,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -101030,7 +101267,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &838 + items: &841 type: object properties: type: @@ -101056,8 +101293,6 @@ paths: example: commit details: oneOf: - - *679 - - *680 - *681 - *682 - *683 @@ -101069,6 +101304,8 @@ paths: - *689 - *690 - *691 + - *692 + - *693 examples: default: value: @@ -101163,14 +101400,14 @@ paths: schema: type: object properties: - reason: &693 + reason: &695 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *692 + placeholder_id: *694 required: - reason - placeholder_id @@ -101187,7 +101424,7 @@ paths: schema: type: object properties: - reason: *693 + reason: *695 expire_at: type: string format: date-time @@ -101249,7 +101486,7 @@ paths: properties: incremental_scans: type: array - items: &694 + items: &696 description: Information on a single scan performed by secret scanning on the repository type: object @@ -101280,15 +101517,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *694 + items: *696 backfill_scans: type: array - items: *694 + items: *696 custom_pattern_backfill_scans: type: array items: allOf: - - *694 + - *696 - type: object properties: pattern_name: @@ -101301,7 +101538,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *694 + items: *696 examples: default: value: @@ -101411,9 +101648,9 @@ paths: application/json: schema: type: array - items: *695 + items: *697 examples: - default: *696 + default: *698 '400': *14 '404': *6 x-github: @@ -101597,9 +101834,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: &698 + default: &700 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -101934,7 +102171,7 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: default: value: @@ -102082,15 +102319,15 @@ paths: parameters: - *354 - *355 - - *697 + - *699 responses: '200': description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: *698 + default: *700 '403': *29 '404': *6 x-github: @@ -102116,7 +102353,7 @@ paths: parameters: - *354 - *355 - - *697 + - *699 requestBody: required: true content: @@ -102275,10 +102512,10 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: *698 - add_credit: *698 + default: *700 + add_credit: *700 '403': *29 '404': *6 '422': @@ -102318,7 +102555,7 @@ paths: parameters: - *354 - *355 - - *697 + - *699 responses: '202': *39 '400': *14 @@ -102347,7 +102584,7 @@ paths: parameters: - *354 - *355 - - *697 + - *699 responses: '202': description: Response @@ -102491,7 +102728,7 @@ paths: application/json: schema: type: array - items: &699 + items: &701 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -102864,7 +103101,7 @@ paths: application/json: schema: type: array - items: *699 + items: *701 examples: default: value: @@ -102952,7 +103189,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: default: value: @@ -103046,7 +103283,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &701 + schema: &703 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -103141,7 +103378,7 @@ paths: description: Response content: application/json: - schema: *701 + schema: *703 examples: default: value: @@ -103348,7 +103585,7 @@ paths: description: Response content: application/json: - schema: &702 + schema: &704 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -103360,7 +103597,7 @@ paths: required: - names examples: - default: &703 + default: &705 value: names: - octocat @@ -103415,9 +103652,9 @@ paths: description: Response content: application/json: - schema: *702 + schema: *704 examples: - default: *703 + default: *705 '404': *6 '422': *7 x-github: @@ -103440,7 +103677,7 @@ paths: parameters: - *354 - *355 - - &704 + - &706 name: per description: The time frame to display results for. in: query @@ -103469,7 +103706,7 @@ paths: example: 128 clones: type: array - items: &705 + items: &707 title: Traffic type: object properties: @@ -103710,7 +103947,7 @@ paths: parameters: - *354 - *355 - - *704 + - *706 responses: '200': description: Response @@ -103729,7 +103966,7 @@ paths: example: 3782 views: type: array - items: *705 + items: *707 required: - uniques - count @@ -104500,7 +104737,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &706 + text_matches: &708 title: Search Result Text Matches type: array items: @@ -104662,7 +104899,7 @@ paths: enum: - author-date - committer-date - - &707 + - &709 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 @@ -104790,7 +105027,7 @@ paths: type: number node_id: type: string - text_matches: *706 + text_matches: *708 required: - sha - node_id @@ -104982,7 +105219,7 @@ paths: - interactions - created - updated - - *707 + - *709 - *17 - *19 - name: advanced_search @@ -105096,8 +105333,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -105125,7 +105362,7 @@ paths: type: string format: date-time nullable: true - text_matches: *706 + text_matches: *708 pull_request: type: object properties: @@ -105405,7 +105642,7 @@ paths: enum: - created - updated - - *707 + - *709 - *17 - *19 responses: @@ -105449,7 +105686,7 @@ paths: nullable: true score: type: number - text_matches: *706 + text_matches: *708 required: - id - node_id @@ -105534,7 +105771,7 @@ paths: - forks - help-wanted-issues - updated - - *707 + - *709 - *17 - *19 responses: @@ -105782,7 +106019,7 @@ paths: - admin - pull - push - text_matches: *706 + text_matches: *708 temp_clone_token: type: string allow_merge_commit: @@ -106082,7 +106319,7 @@ paths: type: string format: uri nullable: true - text_matches: *706 + text_matches: *708 related: type: array nullable: true @@ -106273,7 +106510,7 @@ paths: - followers - repositories - joined - - *707 + - *709 - *17 - *19 responses: @@ -106377,7 +106614,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *706 + text_matches: *708 blog: type: string nullable: true @@ -106456,7 +106693,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &710 + - &712 name: team_id description: The unique identifier of the team. in: path @@ -106497,7 +106734,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *710 + - *712 requestBody: required: true content: @@ -106597,7 +106834,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *710 + - *712 responses: '204': description: Response @@ -106626,7 +106863,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *710 + - *712 - *17 - *19 responses: @@ -106666,7 +106903,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *710 + - *712 - name: role description: Filters members returned by their role in the team. in: query @@ -106687,9 +106924,9 @@ paths: application/json: schema: type: array - items: *711 + items: *713 examples: - default: *712 + default: *714 headers: Link: *70 '404': *6 @@ -106717,7 +106954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *710 + - *712 - *74 responses: '204': @@ -106754,7 +106991,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *710 + - *712 - *74 responses: '204': @@ -106794,7 +107031,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *710 + - *712 - *74 responses: '204': @@ -106831,7 +107068,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *710 + - *712 - *74 responses: '200': @@ -106840,7 +107077,7 @@ paths: application/json: schema: *353 examples: - response-if-user-is-a-team-maintainer: *713 + response-if-user-is-a-team-maintainer: *715 '404': *6 x-github: githubCloudOnly: false @@ -106873,7 +107110,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *710 + - *712 - *74 requestBody: required: false @@ -106901,7 +107138,7 @@ paths: application/json: schema: *353 examples: - response-if-users-membership-with-team-is-now-pending: *714 + response-if-users-membership-with-team-is-now-pending: *716 '403': description: Forbidden if team synchronization is set up '422': @@ -106935,7 +107172,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *710 + - *712 - *74 responses: '204': @@ -106963,7 +107200,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *710 + - *712 - *17 - *19 responses: @@ -107005,7 +107242,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *710 + - *712 - *354 - *355 responses: @@ -107013,7 +107250,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *715 + schema: *717 examples: alternative-response-with-extra-repository-information: value: @@ -107163,7 +107400,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *710 + - *712 - *354 - *355 requestBody: @@ -107215,7 +107452,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *710 + - *712 - *354 - *355 responses: @@ -107242,7 +107479,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *710 + - *712 - *17 - *19 responses: @@ -107254,7 +107491,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: *716 + response-if-child-teams-exist: *718 headers: Link: *70 '404': *6 @@ -107287,7 +107524,7 @@ paths: application/json: schema: oneOf: - - &717 + - &719 title: Private User description: Private User type: object @@ -107490,7 +107727,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &744 + - &746 title: Public User description: Public User type: object @@ -107802,7 +108039,7 @@ paths: description: Response content: application/json: - schema: *717 + schema: *719 examples: default: value: @@ -108200,7 +108437,7 @@ paths: type: integer secrets: type: array - items: &718 + items: &720 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -108316,7 +108553,7 @@ paths: description: Response content: application/json: - schema: *718 + schema: *720 examples: default: value: @@ -108729,7 +108966,7 @@ paths: description: Response content: application/json: - schema: &719 + schema: &721 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -108770,7 +109007,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &720 + default: &722 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -108815,9 +109052,9 @@ paths: description: Response content: application/json: - schema: *719 + schema: *721 examples: - default: *720 + default: *722 '404': *6 x-github: githubCloudOnly: false @@ -108854,9 +109091,9 @@ paths: type: integer machines: type: array - items: *721 + items: *723 examples: - default: *722 + default: *724 '304': *37 '500': *55 '401': *25 @@ -109795,7 +110032,7 @@ paths: type: array items: *275 examples: - default: &734 + default: &736 value: - id: 197 name: hello_docker @@ -109896,7 +110133,7 @@ paths: application/json: schema: type: array - items: &723 + items: &725 title: Email description: Email type: object @@ -109961,9 +110198,9 @@ paths: application/json: schema: type: array - items: *723 + items: *725 examples: - default: &736 + default: &738 value: - email: octocat@github.com verified: true @@ -110038,7 +110275,7 @@ paths: application/json: schema: type: array - items: *723 + items: *725 examples: default: value: @@ -110294,7 +110531,7 @@ paths: application/json: schema: type: array - items: &724 + items: &726 title: GPG Key description: A unique encryption key type: object @@ -110425,7 +110662,7 @@ paths: - subkeys - revoked examples: - default: &754 + default: &756 value: - id: 3 name: Octocat's GPG Key @@ -110510,9 +110747,9 @@ paths: description: Response content: application/json: - schema: *724 + schema: *726 examples: - default: &725 + default: &727 value: id: 3 name: Octocat's GPG Key @@ -110569,7 +110806,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &726 + - &728 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -110581,9 +110818,9 @@ paths: description: Response content: application/json: - schema: *724 + schema: *726 examples: - default: *725 + default: *727 '404': *6 '304': *37 '403': *29 @@ -110606,7 +110843,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *726 + - *728 responses: '204': description: Response @@ -111073,7 +111310,7 @@ paths: application/json: schema: type: array - items: &727 + items: &729 title: Key description: Key type: object @@ -111174,9 +111411,9 @@ paths: description: Response content: application/json: - schema: *727 + schema: *729 examples: - default: &728 + default: &730 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -111215,9 +111452,9 @@ paths: description: Response content: application/json: - schema: *727 + schema: *729 examples: - default: *728 + default: *730 '404': *6 '304': *37 '403': *29 @@ -111273,7 +111510,7 @@ paths: application/json: schema: type: array - items: &729 + items: &731 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -111341,7 +111578,7 @@ paths: - account - plan examples: - default: &730 + default: &732 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -111403,9 +111640,9 @@ paths: application/json: schema: type: array - items: *729 + items: *731 examples: - default: *730 + default: *732 headers: Link: *70 '304': *37 @@ -111648,7 +111885,7 @@ paths: application/json: schema: *266 examples: - default: &731 + default: &733 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -111697,7 +111934,7 @@ paths: application/json: schema: *266 examples: - default: *731 + default: *733 '403': *29 '404': *6 '422': *15 @@ -112422,7 +112659,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *269 - - *732 + - *734 responses: '204': description: Response @@ -112535,7 +112772,7 @@ paths: - docker - nuget - container - - *733 + - *735 - *19 - *17 responses: @@ -112547,8 +112784,8 @@ paths: type: array items: *275 examples: - default: *734 - '400': *735 + default: *736 + '400': *737 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112577,7 +112814,7 @@ paths: application/json: schema: *275 examples: - default: &755 + default: &757 value: id: 40201 name: octo-name @@ -112939,9 +113176,9 @@ paths: application/json: schema: type: array - items: *723 + items: *725 examples: - default: *736 + default: *738 headers: Link: *70 '304': *37 @@ -113054,7 +113291,7 @@ paths: type: array items: *82 examples: - default: &743 + default: &745 summary: Default response value: - id: 1296269 @@ -113401,7 +113638,7 @@ paths: type: array items: *556 examples: - default: *737 + default: *739 headers: Link: *70 '304': *37 @@ -113481,7 +113718,7 @@ paths: application/json: schema: type: array - items: &738 + items: &740 title: Social account description: Social media account type: object @@ -113496,7 +113733,7 @@ paths: - provider - url examples: - default: &739 + default: &741 value: - provider: twitter url: https://twitter.com/github @@ -113558,9 +113795,9 @@ paths: application/json: schema: type: array - items: *738 + items: *740 examples: - default: *739 + default: *741 '422': *15 '304': *37 '404': *6 @@ -113647,7 +113884,7 @@ paths: application/json: schema: type: array - items: &740 + items: &742 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -113667,7 +113904,7 @@ paths: - title - created_at examples: - default: &772 + default: &774 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -113731,9 +113968,9 @@ paths: description: Response content: application/json: - schema: *740 + schema: *742 examples: - default: &741 + default: &743 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -113763,7 +114000,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: - - &742 + - &744 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -113775,9 +114012,9 @@ paths: description: Response content: application/json: - schema: *740 + schema: *742 examples: - default: *741 + default: *743 '404': *6 '304': *37 '403': *29 @@ -113800,7 +114037,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: - - *742 + - *744 responses: '204': description: Response @@ -113829,7 +114066,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &773 + - &775 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 @@ -113854,11 +114091,11 @@ paths: type: array items: *82 examples: - default-response: *743 + default-response: *745 application/vnd.github.v3.star+json: schema: type: array - items: &774 + items: &776 title: Starred Repository description: Starred Repository type: object @@ -114227,10 +114464,10 @@ paths: application/json: schema: oneOf: - - *717 - - *744 + - *719 + - *746 examples: - default-response: &748 + default-response: &750 summary: Default response value: login: octocat @@ -114265,7 +114502,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &749 + response-with-git-hub-plan-information: &751 summary: Response with GitHub plan information value: login: octocat @@ -114322,7 +114559,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &746 + - &748 name: user_id description: The unique identifier of the user. in: path @@ -114388,7 +114625,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *745 + - *747 - *17 responses: '200': @@ -114423,7 +114660,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *746 + - *748 - *293 requestBody: required: true @@ -114495,7 +114732,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *747 + schema: *749 examples: table_view: summary: Response for creating a table view @@ -114547,11 +114784,11 @@ paths: application/json: schema: oneOf: - - *717 - - *744 + - *719 + - *746 examples: - default-response: *748 - response-with-git-hub-plan-information: *749 + default-response: *750 + response-with-git-hub-plan-information: *751 '404': *6 x-github: githubCloudOnly: false @@ -114601,8 +114838,8 @@ paths: required: - subject_digests examples: - default: *750 - withPredicateType: *751 + default: *752 + withPredicateType: *753 responses: '200': description: Response @@ -114641,7 +114878,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *752 + default: *754 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -115111,7 +115348,7 @@ paths: application/json: schema: *204 examples: - default: &753 + default: &755 summary: Example response for a user copilot space value: id: 42 @@ -115212,7 +115449,7 @@ paths: application/json: schema: *204 examples: - default: *753 + default: *755 '403': *29 '404': *6 x-github: @@ -115335,7 +115572,7 @@ paths: application/json: schema: *204 examples: - default: *753 + default: *755 '403': *29 '404': *6 '422': *15 @@ -116103,7 +116340,7 @@ paths: type: array items: *275 examples: - default: *734 + default: *736 '403': *29 '401': *25 x-github: @@ -116487,9 +116724,9 @@ paths: application/json: schema: type: array - items: *724 + items: *726 examples: - default: *754 + default: *756 headers: Link: *70 x-github: @@ -116717,7 +116954,7 @@ paths: - docker - nuget - container - - *733 + - *735 - *74 - *19 - *17 @@ -116730,10 +116967,10 @@ paths: type: array items: *275 examples: - default: *734 + default: *736 '403': *29 '401': *25 - '400': *735 + '400': *737 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -116763,7 +117000,7 @@ paths: application/json: schema: *275 examples: - default: *755 + default: *757 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117112,7 +117349,7 @@ paths: type: array items: *297 examples: - default: *756 + default: *758 headers: Link: *70 '304': *37 @@ -117172,7 +117409,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *757 + items: *759 required: - name - data_type @@ -117188,7 +117425,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *758 + iteration_configuration: *760 required: - name - data_type @@ -117210,8 +117447,8 @@ paths: value: name: Due date data_type: date - single_select_field: *759 - iteration_field: *760 + single_select_field: *761 + iteration_field: *762 responses: '201': description: Response @@ -117219,11 +117456,11 @@ paths: application/json: schema: *297 examples: - text_field: *761 - number_field: *762 - date_field: *763 - single_select_field: *764 - iteration_field: *765 + text_field: *763 + number_field: *764 + date_field: *765 + single_select_field: *766 + iteration_field: *767 '304': *37 '403': *29 '401': *25 @@ -117245,7 +117482,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *293 - - *766 + - *768 - *74 responses: '200': @@ -117254,7 +117491,7 @@ paths: application/json: schema: *297 examples: - default: *767 + default: *769 headers: Link: *70 '304': *37 @@ -117608,7 +117845,7 @@ paths: parameters: - *293 - *74 - - *768 + - *770 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -118147,7 +118384,7 @@ paths: parameters: - *74 - *124 - - *769 + - *771 - *126 responses: '200': @@ -118246,9 +118483,9 @@ paths: - *124 - *125 - *126 - - *770 + - *772 - *129 - - *771 + - *773 responses: '200': description: Response when getting a billing usage summary @@ -118382,9 +118619,9 @@ paths: application/json: schema: type: array - items: *738 + items: *740 examples: - default: *739 + default: *741 headers: Link: *70 x-github: @@ -118414,9 +118651,9 @@ paths: application/json: schema: type: array - items: *740 + items: *742 examples: - default: *772 + default: *774 headers: Link: *70 x-github: @@ -118441,7 +118678,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *74 - - *773 + - *775 - *62 - *17 - *19 @@ -118453,11 +118690,11 @@ paths: schema: anyOf: - type: array - items: *774 + items: *776 - type: array items: *82 examples: - default-response: *743 + default-response: *745 headers: Link: *70 x-github: @@ -118616,7 +118853,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &775 + enterprise: &777 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -118674,7 +118911,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &776 + installation: &778 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -118693,7 +118930,7 @@ x-webhooks: required: - id - node_id - organization: &777 + organization: &779 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -118753,13 +118990,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &778 + repository: &780 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &810 + properties: &812 id: description: Unique identifier of the repository example: 42 @@ -119443,7 +119680,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &811 + required: &813 - archive_url - assignees_url - blobs_url @@ -119594,10 +119831,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -119673,11 +119910,11 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - rule: &779 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + rule: &781 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) @@ -119900,11 +120137,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - rule: *779 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + rule: *781 sender: *4 required: - action @@ -120087,11 +120324,11 @@ x-webhooks: - everyone required: - from - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - rule: *779 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + rule: *781 sender: *4 required: - action @@ -120175,7 +120412,7 @@ x-webhooks: type: string enum: - completed - check_run: &781 + check_run: &783 title: CheckRun description: A check performed on the code of a given code change type: object @@ -120266,7 +120503,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *780 + deployment: *782 details_url: example: https://example.com type: string @@ -120351,10 +120588,10 @@ x-webhooks: - output - app - pull_requests - installation: *776 - enterprise: *775 - organization: *777 - repository: *778 + installation: *778 + enterprise: *777 + organization: *779 + repository: *780 sender: *4 required: - check_run @@ -120745,11 +120982,11 @@ x-webhooks: type: string enum: - created - check_run: *781 - installation: *776 - enterprise: *775 - organization: *777 - repository: *778 + check_run: *783 + installation: *778 + enterprise: *777 + organization: *779 + repository: *780 sender: *4 required: - check_run @@ -121143,11 +121380,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *781 - installation: *776 - enterprise: *775 - organization: *777 - repository: *778 + check_run: *783 + installation: *778 + enterprise: *777 + organization: *779 + repository: *780 requested_action: description: The action requested by the user. type: object @@ -121550,11 +121787,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *781 - installation: *776 - enterprise: *775 - organization: *777 - repository: *778 + check_run: *783 + installation: *778 + enterprise: *777 + organization: *779 + repository: *780 sender: *4 required: - check_run @@ -122524,10 +122761,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -123226,10 +123463,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -123922,10 +124159,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -124236,20 +124473,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &782 + commit_oid: &784 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: *775 - installation: *776 - organization: *777 - ref: &783 + enterprise: *777 + installation: *778 + organization: *779 + ref: &785 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: *778 + repository: *780 sender: *4 required: - action @@ -124644,12 +124881,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *782 - enterprise: *775 - installation: *776 - organization: *777 - ref: *783 - repository: *778 + commit_oid: *784 + enterprise: *777 + installation: *778 + organization: *779 + ref: *785 + repository: *780 sender: *4 required: - action @@ -124915,12 +125152,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *782 - enterprise: *775 - installation: *776 - organization: *777 - ref: *783 - repository: *778 + commit_oid: *784 + enterprise: *777 + installation: *778 + organization: *779 + ref: *785 + repository: *780 sender: *4 required: - action @@ -125252,12 +125489,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *782 - enterprise: *775 - installation: *776 - organization: *777 - ref: *783 - repository: *778 + commit_oid: *784 + enterprise: *777 + installation: *778 + organization: *779 + ref: *785 + repository: *780 sender: *4 required: - action @@ -125531,16 +125768,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 ref: 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 nullable: true - repository: *778 + repository: *780 sender: *4 required: - action @@ -125777,12 +126014,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *782 - enterprise: *775 - installation: *776 - organization: *777 - ref: *783 - repository: *778 + commit_oid: *784 + enterprise: *777 + installation: *778 + organization: *779 + ref: *785 + repository: *780 sender: *4 required: - action @@ -126093,10 +126330,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -126351,10 +126588,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -126434,18 +126671,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *777 - pusher_type: &784 + organization: *779 + pusher_type: &786 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &785 + ref: &787 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -126455,7 +126692,7 @@ x-webhooks: enum: - tag - branch - repository: *778 + repository: *780 sender: *4 required: - ref @@ -126538,9 +126775,9 @@ x-webhooks: enum: - created definition: *305 - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 sender: *4 required: - action @@ -126625,9 +126862,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 sender: *4 required: - action @@ -126705,9 +126942,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *305 - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 sender: *4 required: - action @@ -126785,9 +127022,9 @@ x-webhooks: enum: - updated definition: *305 - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 sender: *4 required: - action @@ -126864,10 +127101,10 @@ x-webhooks: type: string enum: - updated - enterprise: *775 - installation: *776 - repository: *778 - organization: *777 + enterprise: *777 + installation: *778 + repository: *780 + organization: *779 sender: *4 new_property_values: type: array @@ -126952,18 +127189,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *775 - installation: *776 - organization: *777 - pusher_type: *784 - ref: *785 + enterprise: *777 + installation: *778 + organization: *779 + pusher_type: *786 + ref: *787 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *778 + repository: *780 sender: *4 required: - ref @@ -127044,10 +127281,10 @@ x-webhooks: enum: - assignees_changed alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127128,10 +127365,10 @@ x-webhooks: enum: - auto_dismissed alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127213,10 +127450,10 @@ x-webhooks: enum: - auto_reopened alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127298,10 +127535,10 @@ x-webhooks: enum: - created alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127381,10 +127618,10 @@ x-webhooks: enum: - dismissed alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127464,10 +127701,10 @@ x-webhooks: enum: - fixed alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127548,10 +127785,10 @@ x-webhooks: enum: - reintroduced alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127631,10 +127868,10 @@ x-webhooks: enum: - reopened alert: *512 - installation: *776 - organization: *777 - enterprise: *775 - repository: *778 + installation: *778 + organization: *779 + enterprise: *777 + repository: *780 sender: *4 required: - action @@ -127711,9 +127948,9 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - key: &786 + enterprise: *777 + installation: *778 + key: &788 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -127749,8 +127986,8 @@ x-webhooks: - verified - created_at - read_only - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -127827,11 +128064,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - key: *786 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + key: *788 + organization: *779 + repository: *780 sender: *4 required: - action @@ -128387,12 +128624,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - workflow: &792 + workflow: &794 title: Workflow type: object nullable: true @@ -129133,15 +129370,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *787 - required: *788 + properties: *789 + required: *790 nullable: true pull_requests: type: array items: *625 - repository: *778 - organization: *777 - installation: *776 + repository: *780 + organization: *779 + installation: *778 sender: *4 responses: '200': @@ -129212,7 +129449,7 @@ x-webhooks: type: string enum: - approved - approver: &789 + approver: &791 type: object properties: avatar_url: @@ -129255,11 +129492,11 @@ x-webhooks: type: string comment: type: string - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - reviewers: &790 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + reviewers: &792 type: array items: type: object @@ -129338,7 +129575,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &791 + workflow_job_run: &793 type: object properties: conclusion: @@ -130069,18 +130306,18 @@ x-webhooks: type: string enum: - rejected - approver: *789 + approver: *791 comment: type: string - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - reviewers: *790 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + reviewers: *792 sender: *4 since: type: string - workflow_job_run: *791 + workflow_job_run: *793 workflow_job_runs: type: array items: @@ -130784,13 +131021,13 @@ x-webhooks: type: string enum: - requested - enterprise: *775 + enterprise: *777 environment: type: string - installation: *776 - organization: *777 - repository: *778 - requestor: &797 + installation: *778 + organization: *779 + repository: *780 + requestor: &799 title: User type: object nullable: true @@ -132679,12 +132916,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - workflow: *792 + workflow: *794 workflow_run: title: Deployment Workflow Run type: object @@ -133364,7 +133601,7 @@ x-webhooks: type: string enum: - answered - answer: &795 + answer: &797 type: object properties: author_association: @@ -133521,11 +133758,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -133652,11 +133889,11 @@ x-webhooks: - from required: - category - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -133739,11 +133976,11 @@ x-webhooks: type: string enum: - closed - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -133825,7 +134062,7 @@ x-webhooks: type: string enum: - created - comment: &794 + comment: &796 type: object properties: author_association: @@ -133982,11 +134219,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134069,12 +134306,12 @@ x-webhooks: type: string enum: - deleted - comment: *794 - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + comment: *796 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134169,12 +134406,12 @@ x-webhooks: - from required: - body - comment: *794 - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + comment: *796 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134258,11 +134495,11 @@ x-webhooks: type: string enum: - created - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134344,11 +134581,11 @@ x-webhooks: type: string enum: - deleted - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134448,11 +134685,11 @@ x-webhooks: type: string required: - from - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134534,10 +134771,10 @@ x-webhooks: type: string enum: - labeled - discussion: *793 - enterprise: *775 - installation: *776 - label: &796 + discussion: *795 + enterprise: *777 + installation: *778 + label: &798 title: Label type: object properties: @@ -134569,8 +134806,8 @@ x-webhooks: - color - default - description - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134653,11 +134890,11 @@ x-webhooks: type: string enum: - locked - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134739,11 +134976,11 @@ x-webhooks: type: string enum: - pinned - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134825,11 +135062,11 @@ x-webhooks: type: string enum: - reopened - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -134914,16 +135151,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *793 - new_repository: *778 + new_discussion: *795 + new_repository: *780 required: - new_discussion - new_repository - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135006,10 +135243,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *793 - old_answer: *795 - organization: *777 - repository: *778 + discussion: *795 + old_answer: *797 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135091,12 +135328,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *793 - enterprise: *775 - installation: *776 - label: *796 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135179,11 +135416,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135265,11 +135502,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *793 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + discussion: *795 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -135342,7 +135579,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *775 + enterprise: *777 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -136002,9 +136239,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - forkee @@ -136150,9 +136387,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pages: description: The pages that were updated. type: array @@ -136189,7 +136426,7 @@ x-webhooks: - action - sha - html_url - repository: *778 + repository: *780 sender: *4 required: - pages @@ -136265,10 +136502,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories: &798 + organization: *779 + repositories: &800 description: An array of repository objects that the installation can access. type: array @@ -136294,8 +136531,8 @@ x-webhooks: - name - full_name - private - repository: *778 - requester: *797 + repository: *780 + requester: *799 sender: *4 required: - action @@ -136370,11 +136607,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories: *798 - repository: *778 + organization: *779 + repositories: *800 + repository: *780 requester: nullable: true sender: *4 @@ -136450,11 +136687,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories: *798 - repository: *778 + organization: *779 + repositories: *800 + repository: *780 requester: nullable: true sender: *4 @@ -136530,10 +136767,10 @@ x-webhooks: type: string enum: - added - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories_added: &799 + organization: *779 + repositories_added: &801 description: An array of repository objects, which were added to the installation. type: array @@ -136579,15 +136816,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *778 - repository_selection: &800 + repository: *780 + repository_selection: &802 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *797 + requester: *799 sender: *4 required: - action @@ -136666,10 +136903,10 @@ x-webhooks: type: string enum: - removed - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories_added: *799 + organization: *779 + repositories_added: *801 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -136696,9 +136933,9 @@ x-webhooks: - name - full_name - private - repository: *778 - repository_selection: *800 - requester: *797 + repository: *780 + repository_selection: *802 + requester: *799 sender: *4 required: - action @@ -136777,11 +137014,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories: *798 - repository: *778 + organization: *779 + repositories: *800 + repository: *780 requester: nullable: true sender: *4 @@ -136959,10 +137196,10 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 target_type: type: string @@ -137041,11 +137278,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *775 + enterprise: *777 installation: *22 - organization: *777 - repositories: *798 - repository: *778 + organization: *779 + repositories: *800 + repository: *780 requester: nullable: true sender: *4 @@ -137312,8 +137549,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -138102,8 +138339,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138452,8 +138689,8 @@ x-webhooks: - state - locked - assignee - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -138533,7 +138770,7 @@ x-webhooks: type: string enum: - deleted - comment: &801 + comment: &803 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -138713,8 +138950,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -139499,8 +139736,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139851,8 +140088,8 @@ x-webhooks: - state - locked - assignee - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -139932,7 +140169,7 @@ x-webhooks: type: string enum: - edited - changes: &830 + changes: &832 description: The changes to the comment. type: object properties: @@ -139944,9 +140181,9 @@ x-webhooks: type: string required: - from - comment: *801 - enterprise: *775 - installation: *776 + comment: *803 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -140734,8 +140971,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141084,8 +141321,8 @@ x-webhooks: - state - locked - assignee - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -141166,9 +141403,9 @@ x-webhooks: type: string enum: - pinned - comment: *801 - enterprise: *775 - installation: *776 + comment: *803 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -141958,8 +142195,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142310,8 +142547,8 @@ x-webhooks: - state - locked - assignee - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -142391,9 +142628,9 @@ x-webhooks: type: string enum: - unpinned - comment: *801 - enterprise: *775 - installation: *776 + comment: *803 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -143183,8 +143420,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143535,8 +143772,8 @@ x-webhooks: - state - locked - assignee - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -143625,9 +143862,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -143716,9 +143953,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -143806,9 +144043,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -143897,9 +144134,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -143979,10 +144216,10 @@ x-webhooks: type: string enum: - assigned - assignee: *797 - enterprise: *775 - installation: *776 - issue: &802 + assignee: *799 + enterprise: *777 + installation: *778 + issue: &804 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -144774,8 +145011,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -144895,8 +145132,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -144976,8 +145213,8 @@ x-webhooks: type: string enum: - closed - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -145774,8 +146011,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -146030,8 +146267,8 @@ x-webhooks: required: - state - closed_at - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -146110,8 +146347,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -146899,8 +147136,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -147019,8 +147256,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -147099,8 +147336,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147910,8 +148147,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -148009,7 +148246,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &803 + milestone: &805 title: Milestone description: A collection of related issues and pull requests. type: object @@ -148147,8 +148384,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -148247,8 +148484,8 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149040,8 +149277,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -149161,9 +149398,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *796 - organization: *777 - repository: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -149243,9 +149480,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *775 - installation: *776 - issue: *802 + enterprise: *777 + installation: *778 + issue: *804 issue_field: type: object description: The issue field whose value was set or updated on the @@ -149399,8 +149636,8 @@ x-webhooks: - id required: - from - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -149480,9 +149717,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *775 - installation: *776 - issue: *802 + enterprise: *777 + installation: *778 + issue: *804 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -149563,8 +149800,8 @@ x-webhooks: nullable: true required: - id - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -149644,8 +149881,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150436,8 +150673,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -150557,9 +150794,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *796 - organization: *777 - repository: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -150639,8 +150876,8 @@ x-webhooks: type: string enum: - locked - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151455,8 +151692,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -151553,8 +151790,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -151633,8 +151870,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152443,8 +152680,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -152541,9 +152778,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *803 - organization: *777 - repository: *778 + milestone: *805 + organization: *779 + repository: *780 sender: *4 required: - action @@ -153406,8 +153643,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -153991,8 +154228,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -154776,8 +155013,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -154904,8 +155141,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -154985,9 +155222,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *775 - installation: *776 - issue: &804 + enterprise: *777 + installation: *778 + issue: &806 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -155773,8 +156010,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -155893,8 +156130,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -155973,8 +156210,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -156787,8 +157024,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -156886,8 +157123,8 @@ x-webhooks: user_view_type: type: string type: *257 - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -157756,8 +157993,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -158355,11 +158592,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *775 - installation: *776 - issue: *804 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + issue: *806 + organization: *779 + repository: *780 sender: *4 required: - action @@ -158439,12 +158676,12 @@ x-webhooks: type: string enum: - typed - enterprise: *775 - installation: *776 - issue: *802 + enterprise: *777 + installation: *778 + issue: *804 type: *257 - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -158525,7 +158762,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &833 + assignee: &835 title: User type: object nullable: true @@ -158595,11 +158832,11 @@ x-webhooks: required: - login - id - enterprise: *775 - installation: *776 - issue: *802 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + issue: *804 + organization: *779 + repository: *780 sender: *4 required: - action @@ -158678,12 +158915,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *775 - installation: *776 - issue: *802 - label: *796 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + issue: *804 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -158763,8 +159000,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -159577,8 +159814,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *708 - issue_dependencies_summary: *709 + sub_issues_summary: *710 + issue_dependencies_summary: *711 issue_field_values: type: array items: *573 @@ -159675,8 +159912,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -159756,11 +159993,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *775 - installation: *776 - issue: *804 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + issue: *806 + organization: *779 + repository: *780 sender: *4 required: - action @@ -159839,12 +160076,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *775 - installation: *776 - issue: *802 + enterprise: *777 + installation: *778 + issue: *804 type: *257 - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -159924,11 +160161,11 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - label: *796 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -160006,11 +160243,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - label: *796 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -160120,11 +160357,11 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - label: *796 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + label: *798 + organization: *779 + repository: *780 sender: *4 required: - action @@ -160206,9 +160443,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *775 - installation: *776 - marketplace_purchase: &805 + enterprise: *777 + installation: *778 + marketplace_purchase: &807 title: Marketplace Purchase type: object required: @@ -160291,8 +160528,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *777 - previous_marketplace_purchase: &806 + organization: *779 + previous_marketplace_purchase: &808 title: Marketplace Purchase type: object properties: @@ -160372,7 +160609,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *778 + repository: *780 sender: *4 required: - action @@ -160452,10 +160689,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *775 - installation: *776 - marketplace_purchase: *805 - organization: *777 + enterprise: *777 + installation: *778 + marketplace_purchase: *807 + organization: *779 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -160538,7 +160775,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *778 + repository: *780 sender: *4 required: - action @@ -160620,10 +160857,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *775 - installation: *776 - marketplace_purchase: *805 - organization: *777 + enterprise: *777 + installation: *778 + marketplace_purchase: *807 + organization: *779 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -160705,7 +160942,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *778 + repository: *780 sender: *4 required: - action @@ -160786,8 +161023,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 marketplace_purchase: title: Marketplace Purchase type: object @@ -160869,9 +161106,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *777 - previous_marketplace_purchase: *806 - repository: *778 + organization: *779 + previous_marketplace_purchase: *808 + repository: *780 sender: *4 required: - action @@ -160951,12 +161188,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *775 - installation: *776 - marketplace_purchase: *805 - organization: *777 - previous_marketplace_purchase: *806 - repository: *778 + enterprise: *777 + installation: *778 + marketplace_purchase: *807 + organization: *779 + previous_marketplace_purchase: *808 + repository: *780 sender: *4 required: - action @@ -161058,11 +161295,11 @@ x-webhooks: type: string required: - to - enterprise: *775 - installation: *776 - member: *797 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + member: *799 + organization: *779 + repository: *780 sender: *4 required: - action @@ -161162,11 +161399,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *775 - installation: *776 - member: *797 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + member: *799 + organization: *779 + repository: *780 sender: *4 required: - action @@ -161245,11 +161482,11 @@ x-webhooks: type: string enum: - removed - enterprise: *775 - installation: *776 - member: *797 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + member: *799 + organization: *779 + repository: *780 sender: *4 required: - action @@ -161327,11 +161564,11 @@ x-webhooks: type: string enum: - added - enterprise: *775 - installation: *776 - member: *797 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + member: *799 + organization: *779 + repository: *780 scope: description: The scope of the membership. Currently, can only be `team`. @@ -161407,7 +161644,7 @@ x-webhooks: required: - login - id - team: &807 + team: &809 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -161630,11 +161867,11 @@ x-webhooks: type: string enum: - removed - enterprise: *775 - installation: *776 - member: *797 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + member: *799 + organization: *779 + repository: *780 scope: description: The scope of the membership. Currently, can only be `team`. @@ -161711,7 +161948,7 @@ x-webhooks: required: - login - id - team: *807 + team: *809 required: - action - scope @@ -161793,8 +162030,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *776 - merge_group: &809 + installation: *778 + merge_group: &811 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -161813,15 +162050,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *808 + head_commit: *810 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -161907,10 +162144,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *776 - merge_group: *809 - organization: *777 - repository: *778 + installation: *778 + merge_group: *811 + organization: *779 + repository: *780 sender: *4 required: - action @@ -161983,7 +162220,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 + enterprise: *777 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -162092,16 +162329,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *776 - organization: *777 + installation: *778 + organization: *779 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *810 - required: *811 + properties: *812 + required: *813 nullable: true sender: *4 required: @@ -162182,11 +162419,11 @@ x-webhooks: type: string enum: - closed - enterprise: *775 - installation: *776 - milestone: *803 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + milestone: *805 + organization: *779 + repository: *780 sender: *4 required: - action @@ -162265,9 +162502,9 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - milestone: &812 + enterprise: *777 + installation: *778 + milestone: &814 title: Milestone description: A collection of related issues and pull requests. type: object @@ -162404,8 +162641,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -162484,11 +162721,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - milestone: *803 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + milestone: *805 + organization: *779 + repository: *780 sender: *4 required: - action @@ -162598,11 +162835,11 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - milestone: *803 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + milestone: *805 + organization: *779 + repository: *780 sender: *4 required: - action @@ -162682,11 +162919,11 @@ x-webhooks: type: string enum: - opened - enterprise: *775 - installation: *776 - milestone: *812 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + milestone: *814 + organization: *779 + repository: *780 sender: *4 required: - action @@ -162765,11 +163002,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *797 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + blocked_user: *799 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -162848,11 +163085,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *797 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + blocked_user: *799 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -162931,9 +163168,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - membership: &813 + enterprise: *777 + installation: *778 + membership: &815 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -163040,8 +163277,8 @@ x-webhooks: - role - organization_url - user - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163119,11 +163356,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *775 - installation: *776 - membership: *813 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + membership: *815 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163202,8 +163439,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -163319,10 +163556,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 - user: *797 + user: *799 required: - action - invitation @@ -163400,11 +163637,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *775 - installation: *776 - membership: *813 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + membership: *815 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163491,11 +163728,11 @@ x-webhooks: properties: from: type: string - enterprise: *775 - installation: *776 - membership: *813 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + membership: *815 + organization: *779 + repository: *780 sender: *4 required: - action @@ -163572,9 +163809,9 @@ x-webhooks: type: string enum: - published - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 package: description: Information about the package. type: object @@ -164073,7 +164310,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &814 + items: &816 title: Ruby Gems metadata type: object properties: @@ -164168,7 +164405,7 @@ x-webhooks: - owner - package_version - registry - repository: *778 + repository: *780 sender: *4 required: - action @@ -164244,9 +164481,9 @@ x-webhooks: type: string enum: - updated - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 package: description: Information about the package. type: object @@ -164599,7 +164836,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *814 + items: *816 source_url: type: string format: uri @@ -164669,7 +164906,7 @@ x-webhooks: - owner - package_version - registry - repository: *778 + repository: *780 sender: *4 required: - action @@ -164845,12 +165082,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *775 + enterprise: *777 id: type: integer - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - id @@ -164927,7 +165164,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &815 + personal_access_token_request: &817 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -165073,10 +165310,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *775 - organization: *777 + enterprise: *777 + organization: *779 sender: *4 - installation: *776 + installation: *778 required: - action - personal_access_token_request @@ -165153,11 +165390,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *815 - enterprise: *775 - organization: *777 + personal_access_token_request: *817 + enterprise: *777 + organization: *779 sender: *4 - installation: *776 + installation: *778 required: - action - personal_access_token_request @@ -165233,11 +165470,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *815 - enterprise: *775 - organization: *777 + personal_access_token_request: *817 + enterprise: *777 + organization: *779 sender: *4 - installation: *776 + installation: *778 required: - action - personal_access_token_request @@ -165312,11 +165549,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *815 - organization: *777 - enterprise: *775 + personal_access_token_request: *817 + organization: *779 + enterprise: *777 sender: *4 - installation: *776 + installation: *778 required: - action - personal_access_token_request @@ -165421,7 +165658,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *816 + last_response: *818 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -165453,8 +165690,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 zen: description: Random string of GitHub zen. @@ -165699,10 +165936,10 @@ x-webhooks: - from required: - note - enterprise: *775 - installation: *776 - organization: *777 - project_card: &817 + enterprise: *777 + installation: *778 + organization: *779 + project_card: &819 title: Project Card type: object properties: @@ -165821,7 +166058,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *778 + repository: *780 sender: *4 required: - action @@ -165902,11 +166139,11 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - project_card: *817 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project_card: *819 + repository: *780 sender: *4 required: - action @@ -165986,9 +166223,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 project_card: title: Project Card type: object @@ -166116,8 +166353,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *810 - required: *811 + properties: *812 + required: *813 nullable: true sender: *4 required: @@ -166211,11 +166448,11 @@ x-webhooks: - from required: - note - enterprise: *775 - installation: *776 - organization: *777 - project_card: *817 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project_card: *819 + repository: *780 sender: *4 required: - action @@ -166309,9 +166546,9 @@ x-webhooks: - from required: - column_id - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 project_card: allOf: - title: Project Card @@ -166501,7 +166738,7 @@ x-webhooks: type: string required: - after_id - repository: *778 + repository: *780 sender: *4 required: - action @@ -166581,10 +166818,10 @@ x-webhooks: type: string enum: - closed - enterprise: *775 - installation: *776 - organization: *777 - project: &819 + enterprise: *777 + installation: *778 + organization: *779 + project: &821 title: Project type: object properties: @@ -166708,7 +166945,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *778 + repository: *780 sender: *4 required: - action @@ -166788,10 +167025,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - project_column: &818 + enterprise: *777 + installation: *778 + organization: *779 + project_column: &820 title: Project Column type: object properties: @@ -166830,7 +167067,7 @@ x-webhooks: - name - created_at - updated_at - repository: *778 + repository: *780 sender: *4 required: - action @@ -166909,18 +167146,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - project_column: *818 + enterprise: *777 + installation: *778 + organization: *779 + project_column: *820 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *810 - required: *811 + properties: *812 + required: *813 nullable: true sender: *4 required: @@ -167010,11 +167247,11 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - organization: *777 - project_column: *818 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project_column: *820 + repository: *780 sender: *4 required: - action @@ -167094,11 +167331,11 @@ x-webhooks: type: string enum: - moved - enterprise: *775 - installation: *776 - organization: *777 - project_column: *818 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project_column: *820 + repository: *780 sender: *4 required: - action @@ -167178,11 +167415,11 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - project: *819 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project: *821 + repository: *780 sender: *4 required: - action @@ -167262,18 +167499,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - project: *819 + enterprise: *777 + installation: *778 + organization: *779 + project: *821 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *810 - required: *811 + properties: *812 + required: *813 nullable: true sender: *4 required: @@ -167375,11 +167612,11 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - organization: *777 - project: *819 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project: *821 + repository: *780 sender: *4 required: - action @@ -167458,11 +167695,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *775 - installation: *776 - organization: *777 - project: *819 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + project: *821 + repository: *780 sender: *4 required: - action @@ -167543,8 +167780,8 @@ x-webhooks: type: string enum: - closed - installation: *776 - organization: *777 + installation: *778 + organization: *779 projects_v2: *291 sender: *4 required: @@ -167626,8 +167863,8 @@ x-webhooks: type: string enum: - created - installation: *776 - organization: *777 + installation: *778 + organization: *779 projects_v2: *291 sender: *4 required: @@ -167709,8 +167946,8 @@ x-webhooks: type: string enum: - deleted - installation: *776 - organization: *777 + installation: *778 + organization: *779 projects_v2: *291 sender: *4 required: @@ -167828,8 +168065,8 @@ x-webhooks: type: string to: type: string - installation: *776 - organization: *777 + installation: *778 + organization: *779 projects_v2: *291 sender: *4 required: @@ -167913,7 +168150,7 @@ x-webhooks: type: string enum: - archived - changes: &823 + changes: &825 type: object properties: archived_at: @@ -167927,9 +168164,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *776 - organization: *777 - projects_v2_item: &820 + installation: *778 + organization: *779 + projects_v2_item: &822 title: Projects v2 Item description: An item belonging to a project type: object @@ -168064,9 +168301,9 @@ x-webhooks: nullable: true to: type: string - installation: *776 - organization: *777 - projects_v2_item: *820 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -168148,9 +168385,9 @@ x-webhooks: type: string enum: - created - installation: *776 - organization: *777 - projects_v2_item: *820 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -168231,9 +168468,9 @@ x-webhooks: type: string enum: - deleted - installation: *776 - organization: *777 - projects_v2_item: *820 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -168339,7 +168576,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &821 + - &823 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -168361,7 +168598,7 @@ x-webhooks: required: - id - name - - &822 + - &824 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -168395,8 +168632,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *821 - - *822 + - *823 + - *824 required: - field_value - type: object @@ -168412,9 +168649,9 @@ x-webhooks: nullable: true required: - body - installation: *776 - organization: *777 - projects_v2_item: *820 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -168509,9 +168746,9 @@ x-webhooks: to: type: string nullable: true - installation: *776 - organization: *777 - projects_v2_item: *820 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -168594,10 +168831,10 @@ x-webhooks: type: string enum: - restored - changes: *823 - installation: *776 - organization: *777 - projects_v2_item: *820 + changes: *825 + installation: *778 + organization: *779 + projects_v2_item: *822 sender: *4 required: - action @@ -168679,8 +168916,8 @@ x-webhooks: type: string enum: - reopened - installation: *776 - organization: *777 + installation: *778 + organization: *779 projects_v2: *291 sender: *4 required: @@ -168762,14 +168999,14 @@ x-webhooks: type: string enum: - created - installation: *776 - organization: *777 - projects_v2_status_update: &826 + installation: *778 + organization: *779 + projects_v2_status_update: &828 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *824 - required: *825 + properties: *826 + required: *827 sender: *4 required: - action @@ -168850,9 +169087,9 @@ x-webhooks: type: string enum: - deleted - installation: *776 - organization: *777 - projects_v2_status_update: *826 + installation: *778 + organization: *779 + projects_v2_status_update: *828 sender: *4 required: - action @@ -168988,9 +169225,9 @@ x-webhooks: type: string format: date nullable: true - installation: *776 - organization: *777 - projects_v2_status_update: *826 + installation: *778 + organization: *779 + projects_v2_status_update: *828 sender: *4 required: - action @@ -169061,10 +169298,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - repository @@ -169141,13 +169378,13 @@ x-webhooks: type: string enum: - assigned - assignee: *797 - enterprise: *775 - installation: *776 - number: &827 + assignee: *799 + enterprise: *777 + installation: *778 + number: &829 description: The pull request number. type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -171434,7 +171671,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -171516,11 +171753,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -173802,7 +174039,7 @@ x-webhooks: - draft reason: type: string - repository: *778 + repository: *780 sender: *4 required: - action @@ -173884,11 +174121,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -176170,7 +176407,7 @@ x-webhooks: - draft reason: type: string - repository: *778 + repository: *780 sender: *4 required: - action @@ -176252,11 +176489,11 @@ x-webhooks: type: string enum: - closed - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: &828 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: &830 allOf: - *625 - type: object @@ -176320,7 +176557,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *778 + repository: *780 sender: *4 required: - action @@ -176401,12 +176638,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: *828 - repository: *778 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: *830 + repository: *780 sender: *4 required: - action @@ -176486,11 +176723,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *775 + enterprise: *777 milestone: *609 - number: *827 - organization: *777 - pull_request: &829 + number: *829 + organization: *779 + pull_request: &831 title: Pull Request type: object properties: @@ -178771,7 +179008,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -178850,11 +179087,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -181154,7 +181391,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *778 + repository: *780 sender: *4 required: - action @@ -181278,12 +181515,12 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: *828 - repository: *778 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: *830 + repository: *780 sender: *4 required: - action @@ -181363,11 +181600,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -183652,7 +183889,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -183732,11 +183969,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *775 - installation: *776 - label: *796 - number: *827 - organization: *777 + enterprise: *777 + installation: *778 + label: *798 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -186022,7 +186259,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -186103,10 +186340,10 @@ x-webhooks: type: string enum: - locked - enterprise: *775 - installation: *776 - number: *827 - organization: *777 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -188390,7 +188627,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -188470,12 +188707,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *775 + enterprise: *777 milestone: *609 - number: *827 - organization: *777 - pull_request: *829 - repository: *778 + number: *829 + organization: *779 + pull_request: *831 + repository: *780 sender: *4 required: - action @@ -188554,12 +188791,12 @@ x-webhooks: type: string enum: - opened - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: *828 - repository: *778 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: *830 + repository: *780 sender: *4 required: - action @@ -188640,12 +188877,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: *828 - repository: *778 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: *830 + repository: *780 sender: *4 required: - action @@ -188725,12 +188962,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *775 - installation: *776 - number: *827 - organization: *777 - pull_request: *828 - repository: *778 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: *830 + repository: *780 sender: *4 required: - action @@ -189096,9 +189333,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: type: object properties: @@ -191272,7 +191509,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *778 + repository: *780 sender: *4 required: - action @@ -191352,7 +191589,7 @@ x-webhooks: type: string enum: - deleted - comment: &831 + comment: &833 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -191637,9 +191874,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: type: object properties: @@ -193801,7 +194038,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *778 + repository: *780 sender: *4 required: - action @@ -193881,11 +194118,11 @@ x-webhooks: type: string enum: - edited - changes: *830 - comment: *831 - enterprise: *775 - installation: *776 - organization: *777 + changes: *832 + comment: *833 + enterprise: *777 + installation: *778 + organization: *779 pull_request: type: object properties: @@ -196050,7 +196287,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *778 + repository: *780 sender: *4 required: - action @@ -196131,9 +196368,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: title: Simple Pull Request type: object @@ -198310,7 +198547,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *778 + repository: *780 review: description: The review that was affected. type: object @@ -198557,9 +198794,9 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: title: Simple Pull Request type: object @@ -200609,8 +200846,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *778 - review: &832 + repository: *780 + review: &834 description: The review that was affected. type: object properties: @@ -200843,12 +201080,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: description: The pull request number. type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -203135,7 +203372,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 requested_reviewer: title: User type: object @@ -203219,12 +203456,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: description: The pull request number. type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -205518,7 +205755,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 requested_team: title: Team description: Groups of organization members that gives permissions @@ -205710,12 +205947,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: description: The pull request number. type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -208004,7 +208241,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 requested_reviewer: title: User type: object @@ -208089,12 +208326,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *775 - installation: *776 + enterprise: *777 + installation: *778 number: description: The pull request number. type: integer - organization: *777 + organization: *779 pull_request: title: Pull Request type: object @@ -210374,7 +210611,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 requested_team: title: Team description: Groups of organization members that gives permissions @@ -210555,9 +210792,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: title: Simple Pull Request type: object @@ -212736,8 +212973,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *778 - review: *832 + repository: *780 + review: *834 sender: *4 required: - action @@ -212817,9 +213054,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: title: Simple Pull Request type: object @@ -214907,7 +215144,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *778 + repository: *780 sender: *4 thread: type: object @@ -215294,9 +215531,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 pull_request: title: Simple Pull Request type: object @@ -217370,7 +217607,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *778 + repository: *780 sender: *4 thread: type: object @@ -217694,7 +217931,7 @@ x-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. @@ -217702,10 +217939,8 @@ x-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: @@ -217749,21 +217984,17 @@ x-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: *775 - installation: *776 - number: *827 - organization: *777 + - stacked + enterprise: *777 + installation: *778 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -218750,12 +218981,14 @@ x-webhooks: properties: label: type: string + nullable: true ref: type: string repo: title: Repository description: A git repository type: object + nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -218965,15 +219198,23 @@ x-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 @@ -219461,6 +219702,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -220038,13 +220280,11 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action - number - - before - - after - pull_request - repository - sender @@ -220060,7 +220300,7 @@ x-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. @@ -220068,8 +220308,10 @@ x-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: @@ -220113,18 +220355,21 @@ x-webhooks: content: application/json: schema: - title: pull_request unassigned event + title: pull_request synchronize event type: object properties: action: type: string enum: - - unassigned - assignee: *833 - enterprise: *775 - installation: *776 - number: *827 - organization: *777 + - synchronize + after: + type: string + before: + type: string + enterprise: *777 + installation: *778 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -220477,7 +220722,6 @@ x-webhooks: properties: label: type: string - nullable: true ref: type: string repo: @@ -221112,14 +221356,12 @@ x-webhooks: properties: label: type: string - nullable: true ref: type: string repo: title: Repository description: A git repository type: object - nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -221329,23 +221571,15 @@ x-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 @@ -221833,7 +222067,6 @@ x-webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -222411,13 +222644,16 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 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 @@ -222430,7 +222666,7 @@ x-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. @@ -222438,8 +222674,8 @@ x-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: @@ -222483,18 +222719,18 @@ x-webhooks: content: application/json: schema: - title: pull_request unlabeled event + title: pull_request unassigned event type: object properties: action: type: string enum: - - unlabeled - enterprise: *775 - installation: *776 - label: *796 - number: *827 - organization: *777 + - unassigned + assignee: *835 + enterprise: *777 + installation: *778 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -222843,640 +223079,6 @@ x-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 - nullable: true - 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 - nullable: true - 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 - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - 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 - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - 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: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - 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: @@ -223488,7 +223090,6 @@ x-webhooks: title: Repository description: A git repository type: object - nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -223698,15 +223299,659 @@ x-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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + changed_files: + type: integer + closed_at: + type: string + nullable: true + 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 + nullable: true + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 @@ -224194,6 +224439,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -224771,14 +225017,13 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action - number - pull_request - repository - - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -224791,7 +225036,7 @@ x-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. @@ -224799,9 +225044,8 @@ x-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: @@ -224845,17 +225089,18 @@ x-webhooks: content: application/json: schema: - title: pull_request unlocked event + title: pull_request unlabeled event type: object properties: action: type: string enum: - - unlocked - enterprise: *775 - installation: *776 - number: *827 - organization: *777 + - unlabeled + enterprise: *777 + installation: *778 + label: *798 + number: *829 + organization: *779 pull_request: title: Pull Request type: object @@ -225016,6 +225261,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -225087,6 +225333,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -225119,6 +225366,7 @@ x-webhooks: commit_title: description: Title for the merge commit message. type: string + nullable: true enabled_by: title: User type: object @@ -225839,6 +226087,7 @@ x-webhooks: properties: label: type: string + nullable: true ref: type: string repo: @@ -226055,23 +226304,15 @@ x-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 @@ -226643,6 +226884,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -226781,6 +227023,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -226889,6 +227132,15 @@ x-webhooks: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -227080,6 +227332,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -227124,7 +227377,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *778 + repository: *780 sender: *4 required: - action @@ -227144,20 +227397,19 @@ x-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 @@ -227171,7 +227423,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: push + example: pull_request schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -227199,487 +227451,2841 @@ x-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 - nullable: true - 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 - nullable: true - 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 - nullable: true - 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. + action: type: string - created: - description: Whether this push created the `ref`. - type: boolean - deleted: - description: Whether this push deleted the `ref`. - type: boolean - enterprise: *775 - forced: - description: Whether this push was a force push of the `ref`. - type: boolean - head_commit: - title: Commit + enum: + - unlocked + enterprise: *777 + installation: *778 + number: *829 + organization: *779 + pull_request: + title: Pull Request type: object - nullable: true 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 - nullable: true - 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. + _links: type: object properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string + 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: - - 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: *776 - organization: *777 - pusher: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - 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: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: type: string nullable: true - 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 - nullable: true - 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 - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - 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 - nullable: true - 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: + - resolved + - off-topic + - too heated + - spam + - null + additions: type: integer - organization: - type: string - owner: + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + 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 + nullable: true + properties: + commit_message: + description: Commit message for the merge commit. + type: string + nullable: true + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + changed_files: + type: integer + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - 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 + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull + request. + type: boolean + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true + merged_at: + type: string + nullable: true + format: date-time + merged_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within + its repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: boolean + nullable: true + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - 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: *780 + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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: *777 + forced: + description: Whether this push was a force push of the `ref`. + type: boolean + head_commit: + title: Commit + type: object + nullable: true + 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 + nullable: true + 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 + nullable: true + 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: *778 + organization: *779 + pusher: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 nullable: true @@ -228003,9 +230609,9 @@ x-webhooks: type: string enum: - published - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 registry_package: type: object properties: @@ -228451,7 +231057,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *814 + items: *816 summary: type: string tag_name: @@ -228505,7 +231111,7 @@ x-webhooks: - owner - package_version - registry - repository: *778 + repository: *780 sender: *4 required: - action @@ -228583,9 +231189,9 @@ x-webhooks: type: string enum: - updated - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 registry_package: type: object properties: @@ -228893,7 +231499,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *814 + items: *816 summary: type: string tag_name: @@ -228942,7 +231548,7 @@ x-webhooks: - owner - package_version - registry - repository: *778 + repository: *780 sender: *4 required: - action @@ -229019,10 +231625,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - release: &834 + enterprise: *777 + installation: *778 + organization: *779 + release: &836 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -229340,7 +231946,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *778 + repository: *780 sender: *4 required: - action @@ -229417,11 +232023,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - release: *834 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + release: *836 + repository: *780 sender: *4 required: - action @@ -229538,11 +232144,11 @@ x-webhooks: type: boolean required: - to - enterprise: *775 - installation: *776 - organization: *777 - release: *834 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + release: *836 + repository: *780 sender: *4 required: - action @@ -229620,9 +232226,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -229944,7 +232550,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *778 + repository: *780 sender: *4 required: - action @@ -230020,10 +232626,10 @@ x-webhooks: type: string enum: - published - enterprise: *775 - installation: *776 - organization: *777 - release: &835 + enterprise: *777 + installation: *778 + organization: *779 + release: &837 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -230342,7 +232948,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *778 + repository: *780 sender: *4 required: - action @@ -230418,11 +233024,11 @@ x-webhooks: type: string enum: - released - enterprise: *775 - installation: *776 - organization: *777 - release: *834 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + release: *836 + repository: *780 sender: *4 required: - action @@ -230498,11 +233104,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *775 - installation: *776 - organization: *777 - release: *835 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + release: *837 + repository: *780 sender: *4 required: - action @@ -230578,11 +233184,11 @@ x-webhooks: type: string enum: - published - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - repository_advisory: *695 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + repository_advisory: *697 sender: *4 required: - action @@ -230658,11 +233264,11 @@ x-webhooks: type: string enum: - reported - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - repository_advisory: *695 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + repository_advisory: *697 sender: *4 required: - action @@ -230738,10 +233344,10 @@ x-webhooks: type: string enum: - archived - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -230818,10 +233424,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -230899,10 +233505,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -230986,10 +233592,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -231101,10 +233707,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -231176,10 +233782,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 status: type: string @@ -231260,10 +233866,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -231340,10 +233946,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -231437,10 +234043,10 @@ x-webhooks: - name required: - repository - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -231520,10 +234126,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 repository_ruleset: *339 sender: *4 required: @@ -231602,10 +234208,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 repository_ruleset: *339 sender: *4 required: @@ -231684,10 +234290,10 @@ x-webhooks: type: string enum: - edited - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 repository_ruleset: *339 changes: type: object @@ -231992,10 +234598,10 @@ x-webhooks: - from required: - owner - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -232073,10 +234679,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -232154,7 +234760,7 @@ x-webhooks: type: string enum: - create - alert: &836 + alert: &838 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -232276,10 +234882,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -232485,10 +235091,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -232566,11 +235172,11 @@ x-webhooks: type: string enum: - reopen - alert: *836 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *838 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -232769,10 +235375,10 @@ x-webhooks: enum: - fixed - open - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -232850,7 +235456,7 @@ x-webhooks: type: string enum: - assigned - alert: &837 + alert: &840 type: object properties: number: *188 @@ -232992,11 +235598,12 @@ x-webhooks: properties: *20 required: *21 nullable: true + metadata: *839 assignee: *4 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233074,11 +235681,11 @@ x-webhooks: type: string enum: - created - alert: *837 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233159,11 +235766,11 @@ x-webhooks: type: string enum: - created - alert: *837 - installation: *776 - location: *838 - organization: *777 - repository: *778 + alert: *840 + installation: *778 + location: *841 + organization: *779 + repository: *780 sender: *4 required: - location @@ -233341,6 +235948,168 @@ x-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: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + 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: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + 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: |- @@ -233401,11 +236170,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *837 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233483,11 +236252,11 @@ x-webhooks: type: string enum: - reopened - alert: *837 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233565,11 +236334,11 @@ x-webhooks: type: string enum: - resolved - alert: *837 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233647,12 +236416,12 @@ x-webhooks: type: string enum: - unassigned - alert: *837 + alert: *840 assignee: *4 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233730,11 +236499,11 @@ x-webhooks: type: string enum: - validated - alert: *837 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + alert: *840 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -233860,10 +236629,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *778 - enterprise: *775 - installation: *776 - organization: *777 + repository: *780 + enterprise: *777 + installation: *778 + organization: *779 sender: *4 required: - action @@ -233941,11 +236710,11 @@ x-webhooks: type: string enum: - published - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - security_advisory: &839 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + security_advisory: &842 description: The details of the security advisory, including summary, description, and severity. type: object @@ -234116,11 +236885,11 @@ x-webhooks: type: string enum: - updated - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 - security_advisory: *839 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 + security_advisory: *842 sender: *4 required: - action @@ -234193,10 +236962,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -234369,9 +237138,9 @@ x-webhooks: type: object properties: security_and_analysis: *312 - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: *357 sender: *4 required: @@ -234450,12 +237219,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: &840 + sponsorship: &843 type: object properties: created_at: @@ -234756,12 +237525,12 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: *840 + sponsorship: *843 required: - action - sponsorship @@ -234849,12 +237618,12 @@ x-webhooks: type: string required: - from - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: *840 + sponsorship: *843 required: - action - changes @@ -234931,17 +237700,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &841 + effective_date: &844 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: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: *840 + sponsorship: *843 required: - action - sponsorship @@ -235015,7 +237784,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &842 + changes: &845 type: object properties: tier: @@ -235059,13 +237828,13 @@ x-webhooks: - from required: - tier - effective_date: *841 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + effective_date: *844 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: *840 + sponsorship: *843 required: - action - changes @@ -235142,13 +237911,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *842 - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + changes: *845 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - sponsorship: *840 + sponsorship: *843 required: - action - changes @@ -235222,10 +237991,10 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -235308,10 +238077,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -235731,15 +238500,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *775 + enterprise: *777 id: description: The unique identifier of the status. type: integer - installation: *776 + installation: *778 name: type: string - organization: *777 - repository: *778 + organization: *779 + repository: *780 sender: *4 sha: description: The Commit SHA. @@ -235854,9 +238623,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -235945,9 +238714,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -236036,9 +238805,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -236127,9 +238896,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *776 - organization: *777 - repository: *778 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -236205,12 +238974,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - team: &843 + team: &846 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -236433,9 +239202,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: title: Repository description: A git repository @@ -236893,7 +239662,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *843 + team: *846 required: - action - team @@ -236969,9 +239738,9 @@ x-webhooks: type: string enum: - created - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: title: Repository description: A git repository @@ -237429,7 +240198,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *843 + team: *846 required: - action - team @@ -237506,9 +240275,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: title: Repository description: A git repository @@ -237966,7 +240735,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *843 + team: *846 required: - action - team @@ -238110,9 +240879,9 @@ x-webhooks: - from required: - permissions - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: title: Repository description: A git repository @@ -238570,7 +241339,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *843 + team: *846 required: - action - changes @@ -238648,9 +241417,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *775 - installation: *776 - organization: *777 + enterprise: *777 + installation: *778 + organization: *779 repository: title: Repository description: A git repository @@ -239108,7 +241877,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *843 + team: *846 required: - action - team @@ -239184,10 +241953,10 @@ x-webhooks: type: string enum: - started - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 required: - action @@ -239260,16 +242029,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *775 + enterprise: *777 inputs: type: object nullable: true additionalProperties: true - installation: *776 - organization: *777 + installation: *778 + organization: *779 ref: type: string - repository: *778 + repository: *780 sender: *4 workflow: type: string @@ -239351,10 +242120,10 @@ x-webhooks: type: string enum: - completed - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 workflow_job: allOf: @@ -239670,10 +242439,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 workflow_job: allOf: @@ -240012,10 +242781,10 @@ x-webhooks: type: string enum: - queued - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 workflow_job: type: object @@ -240229,10 +242998,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 workflow_job: type: object @@ -240448,12 +243217,12 @@ x-webhooks: type: string enum: - completed - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - workflow: *792 + workflow: *794 workflow_run: title: Workflow Run type: object @@ -241452,12 +244221,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - workflow: *792 + workflow: *794 workflow_run: title: Workflow Run type: object @@ -242441,12 +245210,12 @@ x-webhooks: type: string enum: - requested - enterprise: *775 - installation: *776 - organization: *777 - repository: *778 + enterprise: *777 + installation: *778 + organization: *779 + repository: *780 sender: *4 - workflow: *792 + workflow: *794 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index df968e73c2..44c64d7793 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -218743,6 +218743,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." @@ -220040,6 +220083,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." @@ -221406,6 +221492,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." @@ -223513,6 +223642,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." @@ -224835,6 +225007,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." @@ -226197,6 +226412,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." @@ -227780,6 +228038,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": { @@ -574263,6 +574539,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." @@ -576120,6 +576439,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." @@ -577284,6 +577646,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." @@ -578656,6 +579061,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." @@ -580782,6 +581230,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." @@ -581961,6 +582452,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." @@ -583329,6 +583863,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." @@ -584928,6 +585505,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": { @@ -587392,6 +587987,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -587420,7 +588037,13 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ] } } } @@ -588714,6 +589337,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -588762,6 +589407,12 @@ "validity": "unknown", "publicly_leaked": false, "multi_repo": false, + "metadata": [ + { + "key": "owner_email", + "value": "owner@example.com" + } + ], "assigned_to": { "login": "octocat", "id": 1, @@ -1325029,11 +1325680,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" }, @@ -1325100,21 +1325751,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).\"", @@ -1326569,7 +1327214,8 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": "string", + "nullable": true }, "ref": { "type": "string" @@ -1326578,6 +1327224,7 @@ "title": "Repository", "description": "A git repository", "type": "object", + "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1326851,7 +1327498,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", @@ -1326860,7 +1327507,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", @@ -1327497,7 +1328144,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1329641,8 +1330289,6 @@ "required": [ "action", "number", - "before", - "after", "pull_request", "repository", "sender" @@ -1329698,11 +1330344,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" }, @@ -1329769,110 +1330415,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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "after": { + "type": "string" + }, + "before": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -1330516,8 +1331072,7 @@ "type": "object", "properties": { "label": { - "type": "string", - "nullable": true + "type": "string" }, "ref": { "type": "string" @@ -1331329,8 +1331884,7 @@ "type": "object", "properties": { "label": { - "type": "string", - "nullable": true + "type": "string" }, "ref": { "type": "string" @@ -1331339,7 +1331893,6 @@ "title": "Repository", "description": "A git repository", "type": "object", - "nullable": true, "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1331613,7 +1332166,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", @@ -1331622,7 +1332175,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", @@ -1332259,8 +1332812,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -1334404,8 +1334956,11 @@ "required": [ "action", "number", + "before", + "after", "pull_request", - "repository" + "repository", + "sender" ], "x-github-breaking-changes": [ { @@ -1334458,11 +1335013,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" }, @@ -1334529,13 +1335084,109 @@ "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -1334627,47 +1335278,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", - "nullable": true - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "number": { "description": "The pull request number.", "type": "integer" @@ -1335221,7 +1335831,8 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": "string", + "nullable": true }, "ref": { "type": "string" @@ -1336317,7 +1336928,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", @@ -1336326,7 +1336937,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", @@ -1336963,7 +1337574,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1339108,8 +1339720,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ], "x-github-breaking-changes": [ { @@ -1339162,11 +1339773,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" }, @@ -1339233,13 +1339844,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": { @@ -1339331,6 +1339942,47 @@ "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", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "number": { "description": "The pull request number.", "type": "integer" @@ -1339624,7 +1340276,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1339721,7 +1340374,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1339763,7 +1340417,8 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": "string", + "nullable": true }, "enabled_by": { "title": "User", @@ -1340693,7 +1341348,8 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": "string", + "nullable": true }, "ref": { "type": "string" @@ -1340976,7 +1341632,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", @@ -1340985,7 +1341641,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", @@ -1341735,7 +1342391,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1341919,7 +1342576,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1342061,7 +1342719,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -1342314,7 +1342981,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1343809,12 +1344477,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": [ { @@ -1343836,7 +1344505,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "push", + "example": "pull_request", "schema": { "type": "string" } @@ -1343879,151 +1344548,14 @@ "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": { + "action": { "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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", - "nullable": true, - "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" + "enum": [ + "unlocked" + ] }, "enterprise": { "title": "Enterprise", @@ -1344093,126 +1344625,6 @@ "avatar_url" ] }, - "forced": { - "description": "Whether this push was a force push of the `ref`.", - "type": "boolean" - }, - "head_commit": { - "title": "Commit", - "type": "object", - "nullable": true, - "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", - "nullable": true, - "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", - "nullable": true, - "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).\"", @@ -1344234,6 +1344646,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.", @@ -1344307,351 +1344723,144 @@ "description" ] }, - "pusher": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": "string", - "nullable": true, - "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": { - "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", - "nullable": true - }, - "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", - "nullable": true - }, - "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", - "nullable": true - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", + "_links": { "type": "object", - "nullable": true, "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", - "nullable": true, - "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", "nullable": true, - "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", "nullable": true, @@ -1344746,756 +1344955,169 @@ "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": { - "nullable": true, - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": "string", - "nullable": true - }, - "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "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" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "MDQ6VXNlcjU4MzIzMQ==" - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "registry_package": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "owner": { + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", "type": "object", + "nullable": true, "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", + "nullable": true }, - "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", - "nullable": true, - "properties": { - "author": { + "enabled_by": { + "title": "User", "type": "object", + "nullable": true, "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true }, "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" @@ -1345503,32 +1345125,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" @@ -1345536,428 +1345172,399 @@ }, "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", - "nullable": true + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false }, - "manifest": { - "type": "object", - "nullable": true + "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", - "nullable": true, - "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" - } - ], - "nullable": true + "allow_update_branch": { + "type": "boolean" }, - "bugs": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], - "nullable": true + "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": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ], - "nullable": true + "collaborators_url": { + "type": "string", + "format": "uri-template" }, - "git_head": { - "type": "string" + "comments_url": { + "type": "string", + "format": "uri-template" }, - "homepage": { - "type": "string" + "commits_url": { + "type": "string", + "format": "uri-template" }, - "license": { - "type": "string" + "compare_url": { + "type": "string", + "format": "uri-template" }, - "main": { - "type": "string" + "contents_url": { + "type": "string", + "format": "uri-template" }, - "repository": { + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { "oneOf": [ { - "type": "string" + "type": "integer" }, { - "type": "object" + "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", "nullable": true }, - "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": { + "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" }, - "maintainers": { - "type": "array", - "items": { - "type": "string" - } + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true }, - "contributors": { - "type": "array", - "items": { - "type": "string" - } + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true }, - "engines": { - "type": "object" + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false }, - "keywords": { - "type": "array", - "items": { - "type": "string" - } + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true }, - "files": { - "type": "array", - "items": { - "type": "string" - } + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] }, - "bin": { - "type": "object" + "homepage": { + "type": "string", + "nullable": true }, - "man": { - "type": "object" + "hooks_url": { + "type": "string", + "format": "uri" }, - "directories": { - "oneOf": [ - { + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { "type": "string" }, - { - "type": "object" + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" } - ], - "nullable": true + }, + "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": { - "type": "string" + "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" + ] }, - "installation_command": { - "type": "string" + "merges_url": { + "type": "string", + "format": "uri" }, - "release_id": { - "type": "integer" + "milestones_url": { + "type": "string", + "format": "uri-template" }, - "commit_oid": { + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", "type": "string" }, - "published_via_actions": { - "type": "boolean" + "node_id": { + "type": "string" }, - "deleted_by_id": { + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { "type": "integer" - } - } - }, - "nuget_metadata": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "integer" - } - ], - "nullable": true - }, - "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", - "nullable": true - }, - "name": { - "type": "string" - }, - "sha1": { - "type": "string", - "nullable": true - }, - "sha256": { - "type": "string", - "nullable": true - }, - "size": { - "type": "integer" - }, - "state": { - "type": "string", - "nullable": true - }, - "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": { + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", "type": "object", + "nullable": true, "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true }, "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" @@ -1345965,1925 +1345572,2069 @@ "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" } - } - }, - "created_at": { - "type": "string" - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string", - "nullable": true + }, + "required": [ + "login", + "id" + ] }, - "prerelease": { + "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" }, - "published_at": { + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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" }, - "tag_name": { + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "target_commitish": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { "type": "string" }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "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", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "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" }, - "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" - } + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "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" } - }, - "platform": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { + ] + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" } }, - "repo": { - "type": "string" + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } }, - "dependencies": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" } }, - "commit_oid": { + "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": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "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" } - } - }, - "summary": { - "type": "string" - }, - "tag_name": { - "type": "string" - }, - "target_commitish": { - "type": "string" - }, - "target_oid": { - "type": "string" + }, + "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" + ] }, - "updated_at": { + "sha": { "type": "string" }, - "version": { - "type": "string" + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] } }, "required": [ - "id", - "version", - "name", - "description", - "summary", - "html_url", - "metadata", - "package_files", - "installation_command", - "package_url" + "label", + "ref", + "sha", + "user", + "repo" ] }, - "registry": { - "type": "object", - "nullable": true, - "properties": { - "about_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" + "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", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } }, - "vendor": { - "type": "string" - } + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] } }, - "updated_at": { + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { "type": "string", "nullable": true - } - }, - "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", - "example": 42, - "type": "integer", - "format": "int64" }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "mergeable": { + "type": "boolean", + "nullable": true }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" + "mergeable_state": { + "type": "string" }, - "full_name": { + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { "type": "string", - "example": "octocat/Hello-World" + "nullable": true, + "format": "date-time" }, - "license": { - "title": "License Simple", - "description": "License Simple", + "merged_by": { + "title": "User", "type": "object", + "nullable": true, "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { + "avatar_url": { "type": "string", - "example": "MIT License" + "format": "uri" }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "deleted": { + "type": "boolean" }, - "spdx_id": { + "email": { "type": "string", - "nullable": true, - "example": "MIT" + "nullable": true }, - "node_id": { + "events_url": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "format": "uri-template" }, - "html_url": { + "followers_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 }, - "node_id": { + "following_url": { "type": "string", - "example": "MDQ6VXNlcjE=" + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri-template" }, "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "login": { + "type": "string" }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "name": { + "type": "string" }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "node_id": { + "type": "string" }, - "subscriptions_url": { + "organizations_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" }, - "organizations_url": { + "received_events_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri" }, "type": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "Bot", + "User", + "Organization" + ] }, - "starred_at": { + "url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri" }, "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "id" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", + "nullable": true, "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { + "closed_at": { "type": "string", - "example": "octocat" + "nullable": true, + "format": "date-time" }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 + "closed_issues": { + "type": "integer" }, - "node_id": { + "created_at": { "type": "string", - "example": "MDQ6VXNlcjE=" + "format": "date-time" }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] }, - "gravatar_id": { + "description": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "url": { + "due_on": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "nullable": true, + "format": "date-time" }, "html_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "id": { + "type": "integer" }, - "organizations_url": { + "labels_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "uri" }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "node_id": { + "type": "string" }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "number": { + "description": "The number of the milestone.", + "type": "integer" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "open_issues": { + "type": "integer" }, - "type": { + "state": { + "description": "The state of the milestone.", "type": "string", - "example": "User" + "enum": [ + "open", + "closed" + ] }, - "site_admin": { - "type": "boolean" + "title": { + "description": "The title of the milestone.", + "type": "string" }, - "starred_at": { + "updated_at": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "date-time" }, - "user_view_type": { + "url": { "type": "string", - "example": "public" + "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 + "node_id": { + "type": "string" }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" }, - "default_branch": { - "description": "The default branch of the repository.", + "patch_url": { "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 + "format": "uri" }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "rebaseable": { "type": "boolean", - "example": true + "nullable": true }, - "topics": { + "requested_reviewers": { "type": "array", "items": { - "type": "string" - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } }, - "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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" + } }, - "site_admin": { - "type": "boolean" - } + "required": [ + "name", + "id" + ] } - }, - "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": { + ] + } + }, + "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", + "nullable": true + }, + "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" - } - }, - "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" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "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" + } }, - "pull": { - "type": "boolean" - } + "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" } }, - "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" - } + "required": [ + "name", + "id" + ] } }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { + "review_comment_url": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" + "format": "uri-template" }, - "watchers": { + "review_comments": { "type": "integer" }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ], - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "action", - "registry_package", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "registry_package", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "registry-package-updated": { - "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", - "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": [ - "updated" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", + "review_comments_url": { "type": "string", - "nullable": true, "format": "uri" }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" + "enum": [ + "open", + "closed" + ] }, - "avatar_url": { + "statuses_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "MDQ6VXNlcjU4MzIzMQ==" - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" }, - "id": { - "type": "integer", - "example": 1 + "title": { + "description": "The title of the pull request.", + "type": "string" }, - "node_id": { + "updated_at": { "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "format": "date-time" }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "registry_package": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "nullable": true - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" + "format": "uri" }, - "owner": { + "user": { + "title": "User", "type": "object", + "nullable": true, "properties": { "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true }, "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" + "type": "integer", + "format": "int64" }, "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" @@ -1347891,457 +1347642,47 @@ }, "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", - "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", - "nullable": true, - "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", - "nullable": true - }, - "name": { - "type": "string" - }, - "sha1": { - "type": "string", - "nullable": true - }, - "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" + "id" ] - }, - "registry": { - "type": "object", - "nullable": true - }, - "updated_at": { - "type": "string" } }, "required": [ + "url", "id", - "name", - "namespace", - "description", - "ecosystem", - "package_type", + "node_id", "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", "created_at", "updated_at", - "owner", - "package_version", - "registry" + "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": { @@ -1349727,8 +1349068,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" + } ] } } @@ -1349742,7 +1349115,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -1349751,13 +1349124,12 @@ } } }, - "release-created": { + "push": { "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 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#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1349779,7 +1349151,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "push", "schema": { "type": "string" } @@ -1349822,91 +1349194,348 @@ "content": { "application/json": { "schema": { - "title": "release created event", + "title": "push event", "type": "object", "properties": { - "action": { + "after": { + "description": "The SHA of the most recent commit on `ref` after the push.", + "type": "string" + }, + "base_ref": { "type": "string", - "enum": [ - "created" - ] + "nullable": true }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] + "before": { + "description": "The SHA of the most recent commit on `ref` before the push.", + "type": "string" }, - "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", + "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", + "nullable": true, + "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", + "nullable": true, + "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).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "forced": { + "description": "Whether this push was a force push of the `ref`.", + "type": "boolean" + }, + "head_commit": { + "title": "Commit", + "type": "object", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true, + "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).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", "example": 1 }, "node_id": { @@ -1349993,618 +1349622,444 @@ "description" ] }, - "release": { - "title": "Release", - "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "pusher": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", "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", - "nullable": true - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "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": { + "date": { "type": "string", - "format": "uri" + "format": "date-time" }, - "author": { - "title": "User", - "type": "object", + "email": { + "type": "string", "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "format": "email" }, - "body": { - "type": "string", - "nullable": true + "name": { + "description": "The git author's name.", + "type": "string" }, - "created_at": { + "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", - "nullable": true, - "format": "date-time" + "format": "uri-template" }, - "updated_at": { + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { "type": "string", - "nullable": true, - "format": "date-time" + "format": "uri-template" }, - "discussion_url": { + "blobs_url": { "type": "string", - "format": "uri" + "format": "uri-template" }, - "draft": { - "description": "Whether the release is a draft or published", - "type": "boolean" + "branches_url": { + "type": "string", + "format": "uri-template" }, - "html_url": { + "clone_url": { "type": "string", "format": "uri" }, - "id": { - "type": "integer" + "collaborators_url": { + "type": "string", + "format": "uri-template" }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" + "comments_url": { + "type": "string", + "format": "uri-template" }, - "name": { + "commits_url": { "type": "string", - "nullable": true + "format": "uri-template" }, - "node_id": { - "type": "string" + "compare_url": { + "type": "string", + "format": "uri-template" }, - "prerelease": { - "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" + "contents_url": { + "type": "string", + "format": "uri-template" }, - "published_at": { + "contributors_url": { "type": "string", - "nullable": true, - "format": "date-time" + "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": { + "created_at": { + "oneOf": [ + { "type": "integer" }, - "url": { + { "type": "string", - "format": "uri" + "format": "date-time" } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" ] }, - "tag_name": { - "description": "The name of the tag.", + "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" }, - "tarball_url": { + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { "type": "string", - "nullable": true, "format": "uri" }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", + "description": { + "type": "string", + "nullable": true + }, + "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" }, - "upload_url": { + "git_commits_url": { "type": "string", "format": "uri-template" }, - "url": { + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { "type": "string", "format": "uri" }, - "zipball_url": { + "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", + "nullable": true + }, + "hooks_url": { "type": "string", - "nullable": true, "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": { + }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { "description": "Unique identifier of the repository", - "example": 42, "type": "integer", "format": "int64" }, - "node_id": { + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "format": "uri-template" }, - "name": { - "description": "The name of the repository.", + "issue_events_url": { "type": "string", - "example": "Team Environment" + "format": "uri-template" }, - "full_name": { + "issues_url": { "type": "string", - "example": "octocat/Hello-World" + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" }, "license": { - "title": "License Simple", - "description": "License Simple", + "title": "License", "type": "object", + "nullable": true, "properties": { "key": { - "type": "string", - "example": "mit" + "type": "string" }, "name": { - "type": "string", - "example": "MIT License" + "type": "string" }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "node_id": { + "type": "string" }, "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "type": "string" }, - "html_url": { + "url": { "type": "string", + "nullable": true, "format": "uri" } }, "required": [ "key", "name", - "url", "spdx_id", + "url", "node_id" - ], - "nullable": true + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "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": { - "title": "Simple User", - "description": "A GitHub user.", + "type": "string" + }, + "owner": { + "title": "User", "type": "object", + "nullable": true, "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, "avatar_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri" }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "deleted": { + "type": "boolean" }, - "url": { + "email": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "nullable": true }, - "html_url": { + "events_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "format": "uri-template" }, "followers_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "format": "uri" }, "following_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri-template" }, "gists_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "format": "uri-template" }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "gravatar_id": { + "type": "string" }, - "subscriptions_url": { + "html_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" }, "organizations_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri" }, "type": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "Bot", + "User", + "Organization" + ] }, - "starred_at": { + "url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri" }, "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "forks": { - "type": "integer" + "id" + ] }, "permissions": { "type": "object", @@ -1350612,1873 +1350067,1408 @@ "admin": { "type": "boolean" }, - "pull": { + "maintain": { "type": "boolean" }, - "triage": { + "pull": { "type": "boolean" }, "push": { "type": "boolean" }, - "maintain": { + "triage": { "type": "boolean" } }, "required": [ - "admin", "pull", - "push" + "push", + "admin" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" }, - "user_view_type": { + { "type": "string", - "example": "public" + "format": "date-time" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { + "releases_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "format": "uri-template" }, - "description": { + "role_name": { "type": "string", - "example": "This your first repo!", "nullable": true }, - "fork": { - "type": "boolean" + "size": { + "type": "integer" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "ssh_url": { + "type": "string" }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "stargazers": { + "type": "integer" }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "stargazers_count": { + "type": "integer" }, - "blobs_url": { + "stargazers_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "format": "uri" }, - "branches_url": { + "statuses_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "format": "uri-template" }, - "collaborators_url": { + "subscribers_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "format": "uri" }, - "comments_url": { + "subscription_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "format": "uri" }, - "commits_url": { + "svn_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "format": "uri" }, - "compare_url": { + "tags_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "format": "uri" }, - "contents_url": { + "teams_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "format": "uri" }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "topics": { + "type": "array", + "items": { + "type": "string" + } }, - "deployments_url": { + "trees_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "format": "uri-template" }, - "downloads_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "format": "date-time" }, - "events_url": { + "url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "format": "uri" }, - "forks_url": { + "visibility": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "enum": [ + "public", + "private", + "internal" + ] }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "watchers": { + "type": "integer" }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "watchers_count": { + "type": "integer" }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "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": { + "nullable": true, + "type": "string" }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "email": { + "nullable": true, + "type": "string" }, - "issue_comment_url": { + "login": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "example": "octocat" }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "issues_url": { + "node_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "MDQ6VXNlcjE=" }, - "keys_url": { + "avatar_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "labels_url": { + "gravatar_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "languages_url": { + "url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/users/octocat" }, - "merges_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "https://github.com/octocat" }, - "notifications_url": { + "followers_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "pulls_url": { + "following_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "releases_url": { + "gists_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "ssh_url": { + "starred_url": { "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "stargazers_url": { + "subscriptions_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/users/octocat/subscriptions" }, - "subscribers_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/users/octocat/orgs" }, - "subscription_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/users/octocat/repos" }, - "tags_url": { + "events_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "teams_url": { + "received_events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://api.github.com/users/octocat/received_events" }, - "trees_url": { + "type": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "example": "User" }, - "clone_url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "example": "\"2020-07-09T00:17:55Z\"" }, - "mirror_url": { + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "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", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, - "hooks_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + "example": "https://github.com/enterprises/octo-business" }, - "svn_url": { + "website_url": { + "description": "The enterprise's website URL.", "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "nullable": true, + "format": "uri" }, - "homepage": { + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "language": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "nullable": true + "example": "Octo Business" }, - "forks_count": { - "type": "integer", - "example": 9 + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" }, - "stargazers_count": { - "type": "integer", - "example": 80 + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" }, - "watchers_count": { - "type": "integer", - "example": 80 + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", "type": "integer", - "example": 108 + "example": 1 }, - "default_branch": { - "description": "The default branch of the repository.", + "node_id": { + "description": "The global node ID of the installation.", "type": "string", - "example": "master" + "example": "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", + "example": "github" }, - "open_issues_count": { + "id": { "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true + "example": 1 }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, - "has_pages": { - "type": "boolean" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "example": true + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "issues_url": { "type": "string", - "enum": [ - "all", - "collaborators_only" - ] + "example": "https://api.github.com/orgs/github/issues" }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "pushed_at": { + "description": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", + "example": "A great organization", "nullable": true - }, + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "registry_package": { + "type": "object", + "properties": { "created_at": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", "nullable": true }, - "updated_at": { + "description": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", "nullable": true }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true + "ecosystem": { + "type": "string" }, - "template_repository": { - "nullable": true, + "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" }, - "name": { + "organizations_url": { "type": "string" }, - "full_name": { + "received_events_url": { "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" + "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", + "nullable": true, + "properties": { + "author": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" }, - "organizations_url": { + "events_url": { "type": "string" }, - "repos_url": { + "followers_url": { "type": "string" }, - "events_url": { + "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" }, - "type": { + "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" } - } - }, - "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" + }, + "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" + ] }, - "hooks_url": { - "type": "string" + "body": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] }, - "svn_url": { + "body_html": { "type": "string" }, - "homepage": { - "type": "string" + "container_metadata": { + "type": "object", + "properties": { + "labels": { + "type": "object", + "nullable": true + }, + "manifest": { + "type": "object", + "nullable": true + }, + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } }, - "language": { + "created_at": { "type": "string" }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { + "description": { "type": "string" }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { + "docker_metadata": { "type": "array", "items": { - "type": "string" + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } } }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { + "draft": { "type": "boolean" }, - "archived": { - "type": "boolean" + "html_url": { + "type": "string" }, - "disabled": { - "type": "boolean" + "id": { + "type": "integer" }, - "visibility": { + "installation_command": { "type": "string" }, - "pushed_at": { + "manifest": { "type": "string" }, - "created_at": { - "type": "string" + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } }, - "updated_at": { + "name": { "type": "string" }, - "permissions": { + "npm_metadata": { "type": "object", + "nullable": true, "properties": { - "admin": { - "type": "boolean" + "name": { + "type": "string" }, - "maintain": { - "type": "boolean" + "version": { + "type": "string" }, - "push": { - "type": "boolean" + "npm_user": { + "type": "string" }, - "triage": { + "author": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "bugs": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "dependencies": { + "type": "object" + }, + "dev_dependencies": { + "type": "object" + }, + "peer_dependencies": { + "type": "object" + }, + "optional_dependencies": { + "type": "object" + }, + "description": { + "type": "string" + }, + "dist": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "git_head": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "license": { + "type": "string" + }, + "main": { + "type": "string" + }, + "repository": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "scripts": { + "type": "object" + }, + "id": { + "type": "string" + }, + "node_version": { + "type": "string" + }, + "npm_version": { + "type": "string" + }, + "has_shrinkwrap": { "type": "boolean" }, - "pull": { + "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" + } + ], + "nullable": true + }, + "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" } } }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ], - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "action", - "release", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "release", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "release-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "release", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "release deleted event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "deleted" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "MDQ6VXNlcjU4MzIzMQ==" - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "release": { - "title": "Release", - "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", - "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", - "nullable": true - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", + "nuget_metadata": { + "type": "array", + "nullable": true, + "items": { "type": "object", - "nullable": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", + "id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "integer" + } + ], "nullable": true }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" + "name": { + "type": "string" }, - "gists_url": { - "type": "string", - "format": "uri-template" + "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" }, - "gravatar_id": { + "created_at": { "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "download_url": { + "type": "string" }, "id": { "type": "integer" }, - "login": { - "type": "string" + "md5": { + "type": "string", + "nullable": true }, "name": { "type": "string" }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { + "sha1": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "nullable": true }, - "starred_url": { + "sha256": { "type": "string", - "format": "uri-template" + "nullable": true }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "size": { + "type": "integer" }, - "type": { + "state": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "nullable": true }, - "url": { - "type": "string", - "format": "uri" + "updated_at": { + "type": "string" } }, "required": [ - "login", - "id" + "download_url", + "id", + "name", + "sha256", + "sha1", + "md5", + "content_type", + "state", + "size", + "created_at", + "updated_at" ] - }, - "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" - }, - "author": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "package_url": { + "type": "string" }, - "deleted": { + "prerelease": { "type": "boolean" }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" + "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" + } + } + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "nullable": true + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string" + } + } }, - "gists_url": { - "type": "string", - "format": "uri-template" + "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" + } + } + } }, - "gravatar_id": { + "summary": { "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { + "tag_name": { "type": "string" }, - "name": { + "target_commitish": { "type": "string" }, - "node_id": { + "target_oid": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" + "updated_at": { + "type": "string" }, - "user_view_type": { + "version": { "type": "string" } }, "required": [ - "login", - "id" + "id", + "version", + "name", + "description", + "summary", + "html_url", + "metadata", + "package_files", + "installation_command", + "package_url" ] }, - "body": { - "type": "string", - "nullable": true - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "updated_at": { - "type": "string", - "nullable": true, - "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", - "nullable": true - }, - "node_id": { - "type": "string" - }, - "prerelease": { - "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" - }, - "published_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "reactions": { - "title": "Reactions", + "registry": { "type": "object", + "nullable": true, "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" + "about_url": { + "type": "string" }, - "rocket": { - "type": "integer" + "name": { + "type": "string" }, - "total_count": { - "type": "integer" + "type": { + "type": "string" }, "url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "vendor": { + "type": "string" } - }, - "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", - "nullable": true, - "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": { + "updated_at": { "type": "string", - "nullable": true, - "format": "uri" + "nullable": true } }, "required": [ - "url", - "assets_url", - "upload_url", - "html_url", "id", - "node_id", - "tag_name", - "target_commitish", "name", - "draft", - "author", - "prerelease", - "immutable", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", "created_at", - "published_at", - "assets", - "tarball_url", "updated_at", - "zipball_url", - "body" + "owner", + "package_version", + "registry" ] }, "repository": { @@ -1353864,8 +1352854,7 @@ }, "required": [ "action", - "release", - "repository", + "registry_package", "sender" ] } @@ -1353880,7 +1352869,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -1353889,13 +1352878,13 @@ } } }, - "release-edited": { + "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": "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", + "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": [ { @@ -1353917,7 +1352906,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -1353960,68 +1352949,14 @@ "content": { "application/json": { "schema": { - "title": "release edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "updated" ] }, - "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).\"", @@ -1354184,220 +1353119,53 @@ "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", - "nullable": true - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "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" - ] - } + "created_at": { + "type": "string" }, - "assets_url": { - "type": "string", - "format": "uri" + "description": { + "nullable": true }, - "author": { - "title": "User", + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { "type": "object", - "nullable": true, "properties": { "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true + "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" @@ -1354405,46 +1353173,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" @@ -1354452,155 +1353206,457 @@ }, "required": [ "login", - "id" + "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", - "nullable": true - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "updated_at": { - "type": "string", - "nullable": true, - "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", - "nullable": true - }, - "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", - "nullable": true, - "format": "date-time" - }, - "reactions": { - "title": "Reactions", + "package_version": { "type": "object", "properties": { - "+1": { - "type": "integer" + "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" + ] }, - "-1": { - "type": "integer" + "body": { + "type": "string" }, - "confused": { - "type": "integer" + "body_html": { + "type": "string" }, - "eyes": { - "type": "integer" + "created_at": { + "type": "string" }, - "heart": { - "type": "integer" + "description": { + "type": "string" }, - "hooray": { - "type": "integer" + "docker_metadata": { + "type": "array", + "items": { + "type": "object", + "nullable": true, + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } }, - "laugh": { - "type": "integer" + "draft": { + "type": "boolean" }, - "rocket": { - "type": "integer" + "html_url": { + "type": "string" }, - "total_count": { + "id": { "type": "integer" }, - "url": { - "type": "string", - "format": "uri" + "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", + "nullable": true + }, + "name": { + "type": "string" + }, + "sha1": { + "type": "string", + "nullable": true + }, + "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": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "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" ] }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "tarball_url": { - "type": "string", - "nullable": true, - "format": "uri" + "registry": { + "type": "object", + "nullable": true }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", + "updated_at": { "type": "string" - }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, - "url": { - "type": "string", - "format": "uri" - }, - "zipball_url": { - "type": "string", - "nullable": true, - "format": "uri" } }, "required": [ - "url", - "assets_url", - "upload_url", - "html_url", "id", - "node_id", - "tag_name", - "target_commitish", "name", - "draft", - "author", - "prerelease", - "immutable", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", "created_at", - "published_at", - "assets", - "tarball_url", "updated_at", - "zipball_url", - "body" + "owner", + "package_version", + "registry" ] }, "repository": { @@ -1355986,9 +1355042,8 @@ }, "required": [ "action", - "changes", - "release", - "repository" + "registry_package", + "sender" ] } } @@ -1356002,7 +1355057,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -1356011,11 +1355066,11 @@ } } }, - "release-prereleased": { + "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 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": "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" }, @@ -1356082,13 +1355137,13 @@ "content": { "application/json": { "schema": { - "title": "release prereleased event", + "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "prereleased" + "created" ] }, "enterprise": { @@ -1356257,28 +1355312,6 @@ "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", @@ -1356286,22 +1355319,6 @@ "title": "Release Asset", "description": "Data related to a release.", "type": "object", - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "digest", - "content_type", - "size", - "download_count", - "created_at", - "updated_at" - ], - "nullable": true, "properties": { "browser_download_url": { "type": "string", @@ -1356353,10 +1355370,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1356439,13 +1355452,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": { @@ -1356456,10 +1355488,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1356545,7 +1355573,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": "string", @@ -1356556,6 +1355588,11 @@ "nullable": true, "format": "date-time" }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1356584,10 +1355621,7 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean", - "enum": [ - true - ] + "type": "boolean" }, "published_at": { "type": "string", @@ -1356597,18 +1355631,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1356641,7 +1355663,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.", @@ -1356660,11 +1355694,6 @@ "type": "string", "format": "uri-template" }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, "url": { "type": "string", "format": "uri" @@ -1356674,7 +1355703,29 @@ "nullable": true, "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", @@ -1358060,7 +1357111,8 @@ "required": [ "action", "release", - "repository" + "repository", + "sender" ] } } @@ -1358083,11 +1357135,11 @@ } } }, - "release-published": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "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" }, @@ -1358154,13 +1357206,13 @@ "content": { "application/json": { "schema": { - "title": "release published event", + "title": "release deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "deleted" ] }, "enterprise": { @@ -1358329,28 +1357381,6 @@ "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", @@ -1358358,22 +1357388,6 @@ "title": "Release Asset", "description": "Data related to a release.", "type": "object", - "required": [ - "url", - "browser_download_url", - "id", - "node_id", - "name", - "label", - "state", - "content_type", - "size", - "digest", - "download_count", - "created_at", - "updated_at" - ], - "nullable": true, "properties": { "browser_download_url": { "type": "string", @@ -1358425,10 +1357439,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1358511,13 +1357521,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": { @@ -1358528,10 +1357557,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1358617,7 +1357642,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "body": { "type": "string", @@ -1358628,6 +1357657,11 @@ "nullable": true, "format": "date-time" }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, "discussion_url": { "type": "string", "format": "uri" @@ -1358666,18 +1357700,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1358710,7 +1357732,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.", @@ -1358725,11 +1357759,6 @@ "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, "upload_url": { "type": "string", "format": "uri-template" @@ -1358743,7 +1357772,29 @@ "nullable": true, "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", @@ -1360129,7 +1359180,8 @@ "required": [ "action", "release", - "repository" + "repository", + "sender" ] } } @@ -1360152,11 +1359204,11 @@ } } }, - "release-released": { + "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 published, or a pre-release was changed to a release.", - "operationId": "release/released", + "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" }, @@ -1360223,15 +1359275,68 @@ "content": { "application/json": { "schema": { - "title": "release released event", + "title": "release edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "released" + "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).\"", @@ -1362196,6 +1361301,7 @@ }, "required": [ "action", + "changes", "release", "repository" ] @@ -1362220,11 +1361326,11 @@ } } }, - "release-unpublished": { + "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 or pre-release was unpublished.", - "operationId": "release/unpublished", + "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" }, @@ -1362291,13 +1361397,13 @@ "content": { "application/json": { "schema": { - "title": "release unpublished event", + "title": "release prereleased event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unpublished" + "prereleased" ] }, "enterprise": { @@ -1362475,10 +1361581,10 @@ "draft", "html_url", "id", + "immutable", "name", "node_id", "prerelease", - "immutable", "published_at", "tag_name", "tarball_url", @@ -1362503,9 +1361609,9 @@ "name", "label", "state", + "digest", "content_type", "size", - "digest", "download_count", "created_at", "updated_at" @@ -1362793,7 +1361899,10 @@ }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", - "type": "boolean" + "type": "boolean", + "enum": [ + true + ] }, "published_at": { "type": "string", @@ -1362862,15 +1361971,15 @@ "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", "nullable": true, "format": "date-time" }, - "upload_url": { - "type": "string", - "format": "uri-template" - }, "url": { "type": "string", "format": "uri" @@ -1364289,13 +1363398,13 @@ } } }, - "repository-advisory-published": { + "release-published": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A 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, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1364317,7 +1363426,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -1364360,7 +1363469,7 @@ "content": { "application/json": { "schema": { - "title": "Repository advisory published event", + "title": "release published event", "type": "object", "properties": { "action": { @@ -1364531,6 +1363640,426 @@ "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", + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], + "nullable": true, + "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", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "body": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": "string", + "nullable": true, + "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.", @@ -1365787,1622 +1365316,6 @@ } ] }, - "repository_advisory": { - "description": "A repository security advisory.", - "type": "object", - "properties": { - "ghsa_id": { - "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true - }, - "cve_id": { - "type": "string", - "description": "The Common Vulnerabilities and Exposures (CVE) ID.", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL for the advisory.", - "readOnly": true - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535, - "nullable": true - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "nullable": true, - "enum": [ - "critical", - "high", - "medium", - "low" - ] - }, - "author": { - "readOnly": true, - "nullable": true, - "description": "The author of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "publisher": { - "readOnly": true, - "nullable": true, - "description": "The publisher of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "identifiers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } - }, - "required": [ - "type", - "value" - ] - }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "published_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "closed_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "withdrawn_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "submission": { - "type": "object", - "nullable": true, - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true - } - }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": "array", - "nullable": true, - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": "object", - "nullable": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "nullable": true - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "The range of the package versions affected by the vulnerability.", - "nullable": true - }, - "patched_versions": { - "type": "string", - "description": "The package version(s) that resolve the vulnerability.", - "nullable": true - }, - "vulnerable_functions": { - "type": "array", - "description": "The functions in the package that are affected.", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" - ], - "additionalProperties": false - } - }, - "cvss": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS vector.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_severities": { - "type": "object", - "nullable": true, - "properties": { - "cvss_v3": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 3 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 4 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "cwes": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - }, - "readOnly": true - }, - "cwe_ids": { - "type": "array", - "description": "A list of only the CWE IDs.", - "nullable": true, - "items": { - "type": "string" - } - }, - "credits": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - } - } - }, - "credits_detailed": { - "type": "array", - "nullable": true, - "items": { - "description": "A credit given to a user for a repository security advisory.", - "type": "object", - "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" - ] - } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false - }, - "readOnly": true - }, - "collaborating_users": { - "type": "array", - "description": "A list of users that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "collaborating_teams": { - "type": "array", - "description": "A list of teams that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "access_source": { - "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", - "type": "string", - "enum": [ - "direct", - "organization", - "enterprise" - ], - "example": "direct" - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "private_fork": { - "readOnly": true, - "nullable": true, - "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", - "allOf": [ - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the 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" - ] - } - ] - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cvss", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ], - "additionalProperties": false, - "x-github-breaking-changes": [ - { - "changeset": "deprecate_cvss", - "patch": { - "properties": { - "cvss": null - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ] - }, - "version": "2026-03-10" - } - ] - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -1367530,8 +1365443,8 @@ }, "required": [ "action", - "repository", - "repository_advisory" + "release", + "repository" ] } } @@ -1367545,7 +1365458,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -1367554,13 +1365467,13 @@ } } }, - "repository-advisory-reported": { + "release-released": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A private vulnerability report was submitted.", - "operationId": "repository-advisory/reported", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1367582,7 +1365495,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -1367625,13 +1365538,13 @@ "content": { "application/json": { "schema": { - "title": "Repository advisory reported event", + "title": "release released event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reported" + "released" ] }, "enterprise": { @@ -1367796,206 +1365709,625 @@ "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.", + "release": { + "title": "Release", + "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" + "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", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "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" + ] + } }, - "full_name": { + "assets_url": { "type": "string", - "example": "octocat/Hello-World" + "format": "uri" }, - "license": { - "title": "License Simple", - "description": "License Simple", + "author": { + "title": "User", "type": "object", + "nullable": true, "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { + "avatar_url": { "type": "string", - "example": "MIT License" + "format": "uri" }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "deleted": { + "type": "boolean" }, - "spdx_id": { + "email": { "type": "string", - "nullable": true, - "example": "MIT" + "nullable": true }, - "node_id": { + "events_url": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "format": "uri-template" }, - "html_url": { + "followers_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 }, - "node_id": { + "following_url": { "type": "string", - "example": "MDQ6VXNlcjE=" + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri-template" }, "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "login": { + "type": "string" }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "name": { + "type": "string" }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "node_id": { + "type": "string" }, - "subscriptions_url": { + "organizations_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" }, - "organizations_url": { + "received_events_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri" }, "type": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "Bot", + "User", + "Organization" + ] }, - "starred_at": { + "url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri" }, "user_view_type": { - "type": "string", - "example": "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" - ], + "id" + ] + }, + "body": { + "type": "string", "nullable": true }, - "forks": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "updated_at": { + "type": "string", + "nullable": true, + "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" }, - "permissions": { + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean" + }, + "name": { + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "reactions": { + "title": "Reactions", "type": "object", "properties": { - "admin": { - "type": "boolean" - }, + "+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", + "nullable": true, + "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", + "nullable": true, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, "pull": { "type": "boolean" }, @@ -1369052,1622 +1367384,6 @@ } ] }, - "repository_advisory": { - "description": "A repository security advisory.", - "type": "object", - "properties": { - "ghsa_id": { - "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true - }, - "cve_id": { - "type": "string", - "description": "The Common Vulnerabilities and Exposures (CVE) ID.", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL for the advisory.", - "readOnly": true - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535, - "nullable": true - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "nullable": true, - "enum": [ - "critical", - "high", - "medium", - "low" - ] - }, - "author": { - "readOnly": true, - "nullable": true, - "description": "The author of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "publisher": { - "readOnly": true, - "nullable": true, - "description": "The publisher of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "identifiers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } - }, - "required": [ - "type", - "value" - ] - }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "published_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "closed_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "withdrawn_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true, - "nullable": true - }, - "submission": { - "type": "object", - "nullable": true, - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true - } - }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": "array", - "nullable": true, - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": "object", - "nullable": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "nullable": true - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "The range of the package versions affected by the vulnerability.", - "nullable": true - }, - "patched_versions": { - "type": "string", - "description": "The package version(s) that resolve the vulnerability.", - "nullable": true - }, - "vulnerable_functions": { - "type": "array", - "description": "The functions in the package that are affected.", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" - ], - "additionalProperties": false - } - }, - "cvss": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS vector.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_severities": { - "type": "object", - "nullable": true, - "properties": { - "cvss_v3": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 3 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 4 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "cwes": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - }, - "readOnly": true - }, - "cwe_ids": { - "type": "array", - "description": "A list of only the CWE IDs.", - "nullable": true, - "items": { - "type": "string" - } - }, - "credits": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - } - } - }, - "credits_detailed": { - "type": "array", - "nullable": true, - "items": { - "description": "A credit given to a user for a repository security advisory.", - "type": "object", - "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" - ] - } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false - }, - "readOnly": true - }, - "collaborating_users": { - "type": "array", - "description": "A list of users that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "collaborating_teams": { - "type": "array", - "description": "A list of teams that collaborate on the advisory.", - "nullable": true, - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "access_source": { - "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", - "type": "string", - "enum": [ - "direct", - "organization", - "enterprise" - ], - "example": "direct" - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "private_fork": { - "readOnly": true, - "nullable": true, - "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", - "allOf": [ - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the 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" - ] - } - ] - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cvss", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ], - "additionalProperties": false, - "x-github-breaking-changes": [ - { - "changeset": "deprecate_cvss", - "patch": { - "properties": { - "cvss": null - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ] - }, - "version": "2026-03-10" - } - ] - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -1370795,8 +1367511,8 @@ }, "required": [ "action", - "repository", - "repository_advisory" + "release", + "repository" ] } } @@ -1370810,7 +1367526,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -1370819,13 +1367535,13 @@ } } }, - "repository-archived": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was archived.", - "operationId": "repository/archived", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1370847,7 +1367563,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "release", "schema": { "type": "string" } @@ -1370890,13 +1367606,13 @@ "content": { "application/json": { "schema": { - "title": "repository archived event", + "title": "release unpublished event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "archived" + "unpublished" ] }, "enterprise": { @@ -1371061,202 +1367777,622 @@ "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.", + "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": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" + "assets": { + "type": "array", + "items": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": "object", + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], + "nullable": true, + "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", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } }, - "full_name": { + "assets_url": { "type": "string", - "example": "octocat/Hello-World" + "format": "uri" }, - "license": { - "title": "License Simple", - "description": "License Simple", + "author": { + "title": "User", "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { + "avatar_url": { "type": "string", - "example": "MIT License" + "format": "uri" }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "deleted": { + "type": "boolean" }, - "spdx_id": { + "email": { "type": "string", - "nullable": true, - "example": "MIT" + "nullable": true }, - "node_id": { + "events_url": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "format": "uri-template" }, - "html_url": { + "followers_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 }, - "node_id": { + "following_url": { "type": "string", - "example": "MDQ6VXNlcjE=" + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri-template" }, "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "login": { + "type": "string" }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "name": { + "type": "string" }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "node_id": { + "type": "string" }, - "subscriptions_url": { + "organizations_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" }, - "organizations_url": { + "received_events_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri" }, "type": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "Bot", + "User", + "Organization" + ] }, - "starred_at": { + "url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri" }, "user_view_type": { - "type": "string", - "example": "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" - ], + } + }, + "body": { + "type": "string", "nullable": true }, - "forks": { + "created_at": { + "type": "string", + "nullable": true, + "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" }, - "permissions": { - "type": "object", + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean" + }, + "name": { + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": "string", + "nullable": true, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", "properties": { "admin": { "type": "boolean" @@ -1372444,8 +1369580,8 @@ }, "required": [ "action", - "repository", - "sender" + "release", + "repository" ] } } @@ -1372459,9 +1369595,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -1372469,13 +1369604,13 @@ } } }, - "repository-created": { + "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was created.", - "operationId": "repository/created", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -1372497,7 +1369632,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_advisory", "schema": { "type": "string" } @@ -1372540,13 +1369675,13 @@ "content": { "application/json": { "schema": { - "title": "repository created event", + "title": "Repository advisory published event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "published" ] }, "enterprise": { @@ -1373967,6 +1371102,1622 @@ } ] }, + "repository_advisory": { + "description": "A repository security advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535, + "nullable": true + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "nullable": true, + "enum": [ + "critical", + "high", + "medium", + "low" + ] + }, + "author": { + "readOnly": true, + "nullable": true, + "description": "The author of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "publisher": { + "readOnly": true, + "nullable": true, + "description": "The publisher of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "closed_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "withdrawn_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "submission": { + "type": "object", + "nullable": true, + "readOnly": true, + "properties": { + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true + } + }, + "required": [ + "accepted" + ] + }, + "vulnerabilities": { + "type": "array", + "nullable": true, + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "patched_versions": { + "type": "string", + "description": "The package version(s) that resolve the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected.", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS vector.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "cwes": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": "array", + "description": "A list of only the CWE IDs.", + "nullable": true, + "items": { + "type": "string" + } + }, + "credits": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + } + } + }, + "credits_detailed": { + "type": "array", + "nullable": true, + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "state": { + "type": "string", + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" + ] + } + }, + "required": [ + "user", + "type", + "state" + ], + "additionalProperties": false + }, + "readOnly": true + }, + "collaborating_users": { + "type": "array", + "description": "A list of users that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "collaborating_teams": { + "type": "array", + "description": "A list of teams that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "access_source": { + "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", + "type": "string", + "enum": [ + "direct", + "organization", + "enterprise" + ], + "example": "direct" + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + } + }, + "private_fork": { + "readOnly": true, + "nullable": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the 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" + ] + } + ] + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cvss", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ], + "additionalProperties": false, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": { + "properties": { + "cvss": null + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ] + }, + "version": "2026-03-10" + } + ] + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -1374095,7 +1372846,7 @@ "required": [ "action", "repository", - "sender" + "repository_advisory" ] } } @@ -1374109,9 +1372860,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -1374119,13 +1372869,13 @@ } } }, - "repository-deleted": { + "repository-advisory-reported": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", - "operationId": "repository/deleted", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -1374147,7 +1372897,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_advisory", "schema": { "type": "string" } @@ -1374190,13 +1372940,13 @@ "content": { "application/json": { "schema": { - "title": "repository deleted event", + "title": "Repository advisory reported event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "reported" ] }, "enterprise": { @@ -1375617,94 +1374367,1710 @@ } ] }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", + "repository_advisory": { + "description": "A repository security advisory.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { + "ghsa_id": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "description": "The GitHub Security Advisory ID.", + "readOnly": true }, - "gravatar_id": { + "cve_id": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", "nullable": true }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "description": "The API URL for the advisory.", + "readOnly": true }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat" + "description": "The URL for the advisory.", + "readOnly": true }, - "followers_url": { + "summary": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "description": "A short summary of the advisory.", + "maxLength": 1024 }, - "following_url": { + "description": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535, + "nullable": true }, - "gists_url": { + "severity": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "description": "The severity of the advisory.", + "nullable": true, + "enum": [ + "critical", + "high", + "medium", + "low" + ] }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "author": { + "readOnly": true, + "nullable": true, + "description": "The author of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "publisher": { + "readOnly": true, + "nullable": true, + "description": "The publisher of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true }, - "repos_url": { + "state": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" + ] }, - "events_url": { + "created_at": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true, + "nullable": true }, - "received_events_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true, + "nullable": true }, - "type": { + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "closed_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "withdrawn_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "submission": { + "type": "object", + "nullable": true, + "readOnly": true, + "properties": { + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true + } + }, + "required": [ + "accepted" + ] + }, + "vulnerabilities": { + "type": "array", + "nullable": true, + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "patched_versions": { + "type": "string", + "description": "The package version(s) that resolve the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected.", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS vector.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "cwes": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": "array", + "description": "A list of only the CWE IDs.", + "nullable": true, + "items": { + "type": "string" + } + }, + "credits": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + } + } + }, + "credits_detailed": { + "type": "array", + "nullable": true, + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "state": { + "type": "string", + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" + ] + } + }, + "required": [ + "user", + "type", + "state" + ], + "additionalProperties": false + }, + "readOnly": true + }, + "collaborating_users": { + "type": "array", + "description": "A list of users that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "collaborating_teams": { + "type": "array", + "description": "A list of teams that collaborate on the advisory.", + "nullable": true, + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "access_source": { + "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", + "type": "string", + "enum": [ + "direct", + "organization", + "enterprise" + ], + "example": "direct" + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + } + }, + "private_fork": { + "readOnly": true, + "nullable": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the 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" + ] + } + ] + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cvss", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ], + "additionalProperties": false, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": { + "properties": { + "cvss": null + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ] + }, + "version": "2026-03-10" + } + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { "type": "string", "example": "User" }, @@ -1375745,7 +1376111,7 @@ "required": [ "action", "repository", - "sender" + "repository_advisory" ] } } @@ -1375759,9 +1376125,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -1375769,12 +1376134,13 @@ } } }, - "repository-dispatch-sample.collected": { + "repository-archived": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was archived.", + "operationId": "repository/archived", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1375796,7 +1376162,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_dispatch", + "example": "repository", "schema": { "type": "string" } @@ -1375839,21 +1376205,14 @@ "content": { "application/json": { "schema": { - "title": "repository_dispatch event", + "title": "repository archived event", "type": "object", "properties": { "action": { "type": "string", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." - }, - "branch": { - "type": "string" - }, - "client_payload": { - "type": "object", - "nullable": true, - "additionalProperties": true, - "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + "enum": [ + "archived" + ] }, "enterprise": { "title": "Enterprise", @@ -1377400,11 +1377759,8 @@ }, "required": [ "action", - "branch", - "client_payload", "repository", - "sender", - "installation" + "sender" ] } } @@ -1377418,18 +1377774,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "repository-created": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The topics, default branch, description, or homepage of a repository was changed.", - "operationId": "repository/edited", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -1377496,67 +1377855,15 @@ "content": { "application/json": { "schema": { - "title": "repository edited event", + "title": "repository created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "created" ] }, - "changes": { - "type": "object", - "properties": { - "default_branch": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "description": { - "type": "object", - "properties": { - "from": { - "type": "string", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "homepage": { - "type": "object", - "properties": { - "from": { - "type": "string", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "topics": { - "type": "object", - "properties": { - "from": { - "type": "array", - "nullable": true, - "items": { - "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).\"", @@ -1379102,7 +1379409,6 @@ }, "required": [ "action", - "changes", "repository", "sender" ] @@ -1379128,12 +1379434,13 @@ } } }, - "repository-import": { + "repository-deleted": { "post": { - "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", - "operationId": "repository-import", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1379155,7 +1379462,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_import", + "example": "repository", "schema": { "type": "string" } @@ -1379198,9 +1379505,15 @@ "content": { "application/json": { "schema": { - "title": "repository_import event", + "title": "repository deleted event", "type": "object", "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, "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).\"", @@ -1380742,18 +1381055,10 @@ "type", "url" ] - }, - "status": { - "type": "string", - "enum": [ - "success", - "cancelled", - "failure" - ] } }, "required": [ - "status", + "action", "repository", "sender" ] @@ -1380769,21 +1381074,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-privatized": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -1380805,7 +1381111,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_dispatch", "schema": { "type": "string" } @@ -1380848,14 +1381154,21 @@ "content": { "application/json": { "schema": { - "title": "repository privatized event", + "title": "repository_dispatch event", "type": "object", "properties": { "action": { "type": "string", - "enum": [ - "privatized" - ] + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, + "branch": { + "type": "string" + }, + "client_payload": { + "type": "object", + "nullable": true, + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "title": "Enterprise", @@ -1382402,8 +1382715,11 @@ }, "required": [ "action", + "branch", + "client_payload", "repository", - "sender" + "sender", + "installation" ] } } @@ -1382417,21 +1382733,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "repository-publicized": { + "repository-edited": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -1382498,15 +1382811,67 @@ "content": { "application/json": { "schema": { - "title": "repository publicized event", + "title": "repository edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicized" + "edited" ] }, + "changes": { + "type": "object", + "properties": { + "default_branch": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "description": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "homepage": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "topics": { + "type": "object", + "properties": { + "from": { + "type": "array", + "nullable": true, + "items": { + "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).\"", @@ -1384052,6 +1384417,7 @@ }, "required": [ "action", + "changes", "repository", "sender" ] @@ -1384077,13 +1384443,12 @@ } } }, - "repository-renamed": { + "repository-import": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -1384105,7 +1384470,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_import", "schema": { "type": "string" } @@ -1384148,42 +1384513,9 @@ "content": { "application/json": { "schema": { - "title": "repository renamed event", + "title": "repository_import event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "renamed" - ] - }, - "changes": { - "type": "object", - "properties": { - "repository": { - "type": "object", - "properties": { - "name": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "name" - ] - } - }, - "required": [ - "repository" - ] - }, "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).\"", @@ -1385725,11 +1386057,18 @@ "type", "url" ] + }, + "status": { + "type": "string", + "enum": [ + "success", + "cancelled", + "failure" + ] } }, "required": [ - "action", - "changes", + "status", "repository", "sender" ] @@ -1385745,23 +1386084,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_import", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-ruleset-created": { + "repository-privatized": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1385783,7 +1386120,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -1385826,13 +1386163,13 @@ "content": { "application/json": { "schema": { - "title": "repository ruleset created event", + "title": "repository privatized event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "privatized" ] }, "enterprise": { @@ -1387253,1338 +1387590,6 @@ } ] }, - "repository_ruleset": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": "integer", - "nullable": true, - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey", - "User" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", - "enum": [ - "always", - "pull_request", - "exempt" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never", - "exempt" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": "object", - "nullable": true, - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "nullable": true, - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ] - }, - "rules": { - "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." - }, - "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" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -1388712,7 +1387717,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1388727,8 +1387732,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1388736,13 +1387742,13 @@ } } }, - "repository-ruleset-deleted": { + "repository-publicized": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1388764,7 +1387770,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -1388807,13 +1387813,13 @@ "content": { "application/json": { "schema": { - "title": "repository ruleset deleted event", + "title": "repository publicized event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "publicized" ] }, "enterprise": { @@ -1390234,1338 +1389240,6 @@ } ] }, - "repository_ruleset": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": "integer", - "nullable": true, - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey", - "User" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", - "enum": [ - "always", - "pull_request", - "exempt" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never", - "exempt" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": "object", - "nullable": true, - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "nullable": true, - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ] - }, - "rules": { - "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." - }, - "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" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -1391693,7 +1389367,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1391708,8 +1389382,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1391717,13 +1389392,13 @@ } } }, - "repository-ruleset-edited": { + "repository-renamed": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1391745,7 +1389420,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -1391788,13 +1389463,1691 @@ "content": { "application/json": { "schema": { - "title": "repository ruleset edited event", + "title": "repository renamed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "renamed" + ] + }, + "changes": { + "type": "object", + "properties": { + "repository": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "repository" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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-ruleset-created": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "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_ruleset", + "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 ruleset created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" ] }, "enterprise": { @@ -1393859,6 +1393212,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." @@ -1394547,1974 +1393943,6226 @@ } } }, - "changes": { + "sender": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { "name": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } + "nullable": true, + "type": "string" }, - "enforcement": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } + "email": { + "nullable": true, + "type": "string" }, - "conditions": { - "type": "object", - "properties": { - "added": { - "type": "array", - "items": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "deleted": { - "type": "array", - "items": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "updated": { - "type": "array", - "items": { - "type": "object", - "properties": { - "condition": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - "changes": { - "type": "object", - "properties": { - "condition_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "target": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "include": { - "type": "object", - "properties": { - "from": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "exclude": { - "type": "object", - "properties": { - "from": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - } - } - } + "login": { + "type": "string", + "example": "octocat" }, - "rules": { - "type": "object", - "properties": { - "added": { - "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" - ] + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-ruleset-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "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_ruleset", + "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 ruleset deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "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" + } + ] + }, + "repository_ruleset": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": "integer", + "nullable": true, + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "User" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", + "enum": [ + "always", + "pull_request", + "exempt" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never", + "exempt" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": "object", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" } } - }, - { - "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." - }, - "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" - ] + } + } + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } } } - }, - "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" - ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } }, - "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" - ] + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } } - }, - "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" - ] + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } }, - "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": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } } - }, - "required": [ - "operator", - "pattern" - ] + } } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] } + ] + } + ] + } + ] + }, + "rules": { + "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" + ] }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", + "parameters": { "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" - ] + "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" + ] }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "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": [ - "committer_email_pattern" + "ALLGREEN", + "HEADGREEN" ] }, - "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": { + "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": [ - "branch_name_pattern" + "MERGE", + "SQUASH", + "REBASE" ] }, - "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" - ] + "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" + ] }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", + "parameters": { "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" - ] + "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" + ] }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] + "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" + ] + } }, - "parameters": { + "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": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { + "allowed_actors": { "type": "array", - "description": "Workflows that must pass for this rule to pass.", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", "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": { + "id": { "type": "integer", - "description": "The ID of the repository where the workflow is defined" + "description": "ID of the actor that can dismiss reviews." }, - "sha": { + "type": { "type": "string", - "description": "The commit SHA of the workflow file to use" + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] } }, "required": [ - "path", - "repository_id" + "id", + "type" ] } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." } }, "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" + "enabled" ] }, - "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.", + "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": { - "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" - ] + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." }, - "security_alerts_threshold": { + "type": { "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).\"", + "description": "The type of the reviewer", "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" + "Team" ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" } }, "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" + "id", + "type" ] } - } - }, - "required": [ - "code_scanning_tools" - ] + }, + "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" + ] }, - { - "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.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." }, - "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." + "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." + } }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } + "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." } - } - }, - { - "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" - ] - } - } + "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" + ] }, - { - "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.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "file_path_restriction" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "max_file_path_length" + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "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" - ] + "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" + ] }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "file_extension_restriction" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "max_file_size" + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "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" - ] + "pattern": { + "type": "string", + "description": "The pattern to match with." } - } + }, + "required": [ + "operator", + "pattern" + ] } - ] - } - }, - "deleted": { - "type": "array", - "items": { - "title": "Repository Rule", + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern 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" - ] - } - } + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "update" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "deletion" + "starts_with", + "ends_with", + "contains", + "regex" ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "pattern": { "type": "string", - "enum": [ - "required_linear_history" - ] + "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" + ] }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "merge_queue" - ] + "description": "How this rule appears when configuring it." }, - "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": { + "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": [ - "required_deployments" + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "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" - ] + "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" + ] }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "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": [ - "required_signatures" + "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" + ] }, - { - "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.", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." }, - "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": { + "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", - "enum": [ - "merge", - "squash", - "rebase" - ] + "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" } }, - "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." - }, - "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" - ] + "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" + ] }, - { - "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.", + "parameters": { "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" + "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" } }, - "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" - ] + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } } - } - }, - { - "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" - ] - } - } + "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" + ] }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", + "parameters": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." }, - "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" - ] + "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" + ] }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", + "parameters": { "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" - ] + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } } - } - }, - { - "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" - ] - } - } + "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" + ] }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", + "parameters": { "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" - ] + "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" + ] }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", + "parameters": { "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" - ] + "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" + ] }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "parameters": { "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" - ] + "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 } - } - }, - { - "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" - ] + "max_file_size" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-ruleset-edited": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "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_ruleset", + "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 ruleset edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "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" + } + ] + }, + "repository_ruleset": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": "integer", + "nullable": true, + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "User" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", + "enum": [ + "always", + "pull_request", + "exempt" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never", + "exempt" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": "object", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" } } - }, - { - "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": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } } } } - } - }, - { - "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" + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." } } - }, - "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" - ] - } + "required": [ + "repository_name" + ] } - }, - { - "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" + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } } } - }, - "required": [ - "restricted_file_extensions" - ] + } } - } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + } + ] + } + ] + } + ] + }, + "rules": { + "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" + ] + }, + "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" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "changes": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "enforcement": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "conditions": { + "type": "object", + "properties": { + "added": { + "type": "array", + "items": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "deleted": { + "type": "array", + "items": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "condition": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, + "changes": { + "type": "object", + "properties": { + "condition_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "target": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "include": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "exclude": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "rules": { + "type": "object", + "properties": { + "added": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -1396523,983 +1400171,6394 @@ "type": { "type": "string", "enum": [ - "max_file_size" + "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": { - "max_file_size": { + "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": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "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": [ - "max_file_size" + "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" + ] + }, + "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" + ] + }, + "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" + ] + } + } + } + ] + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "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" + ] + }, + "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" + ] + } + } + } + ] + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", + "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 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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + } + } + }, + "required": [ + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } } }, - "updated": { + "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": "object", - "properties": { - "rule": { - "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." - }, - "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" - ] - } - } - } - ] - }, - "changes": { - "type": "object", - "properties": { - "configuration": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "rule_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "pattern": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - } - } - } + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "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", @@ -1397628,7 +1406687,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1397643,8 +1406702,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1397652,13 +1406712,13 @@ } } }, - "repository-transferred": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to 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" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1397680,7 +1406740,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -1397723,200 +1406783,181 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "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": { + "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", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "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", @@ -1399463,7 +1408504,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1399479,23 +1408520,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": [ { @@ -1399517,7 +1408556,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -1399560,15 +1408599,191 @@ "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", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "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).\"", @@ -1401114,6 +1410329,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1401129,21 +1410345,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" }, @@ -1401210,13 +1410424,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": { @@ -1402955,11 +1412169,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" }, @@ -1403026,13 +1412240,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": { @@ -1403043,9 +1412257,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1403065,10 +1412276,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1403164,9 +1412371,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1403206,7 +1412410,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1404752,280 +1413957,1022 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "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_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "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 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" - }, - "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 reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": "string", - "nullable": true, - "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": [ + "action", + "alert", + "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_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "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 assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "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, + "nullable": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "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": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "description": "The slug identifier for the provider of the secret that was detected.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true + }, + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true + }, + "closure_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1406573,8 +1416520,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1406588,21 +1416534,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": [ { @@ -1406624,7 +1416571,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1406667,179 +1416614,797 @@ "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": { + "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, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "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": "string", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "description": "The slug identifier for the provider of the secret that was detected.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "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" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fix_reason": { - "type": "string" + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "fixed_in": { - "type": "string" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "ghsa_id": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "id": { - "type": "integer" + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "node_id": { - "type": "string" + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true }, - "number": { - "type": "integer" + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true }, - "severity": { - "type": "string" + "closure_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "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" + ] + } } } }, @@ -1408389,8 +1418954,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1408404,21 +1418968,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": [ { @@ -1408440,7 +1419005,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "secret_scanning_alert_location", "schema": { "type": "string" } @@ -1408483,13 +1419048,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": { @@ -1409252,200 +1419817,30 @@ "url" ], "nullable": true - } - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" + "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" + ] + } } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] + } }, "installation": { "title": "Simple Installation", @@ -1409468,6 +1419863,368 @@ "node_id" ] }, + "location": { + "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.", + "example": "commit" + }, + "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", + "example": "/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", + "example": "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", + "example": "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.", + "example": "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", + "example": "/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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "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.", @@ -1410923,10 +1421680,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" + } + } } } } @@ -1410938,8 +1421870,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1410948,11 +1421881,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" }, @@ -1411019,13 +1421952,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": { @@ -1411788,6 +1422721,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1413349,7 +1424304,6 @@ } }, "x-github": { - "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": [ @@ -1413360,13 +1424314,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": [ { @@ -1413388,7 +1424342,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert_location", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -1413431,13 +1424385,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": { @@ -1414200,9 +1425154,99 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1414224,368 +1425268,6 @@ "node_id" ] }, - "location": { - "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.", - "example": "commit" - }, - "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", - "example": "/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", - "example": "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", - "example": "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.", - "example": "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", - "example": "/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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - }, "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.", @@ -1416041,185 +1426723,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" - } - } } } } @@ -1416230,10 +1426737,8 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1417082,6 +1427587,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1419494,6 +1430021,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1421906,6 +1432455,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1424318,6 +1434889,28 @@ "url" ], "nullable": true + }, + "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" + ] + } } } }, @@ -1426854,6 +1437447,28 @@ "url" ], "nullable": true + }, + "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/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 7f3fa413d6..9664a487cd 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1081,7 +1081,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &700 + - &702 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -14271,7 +14271,7 @@ paths: properties: action: type: string - discussion: &796 + discussion: &798 title: Discussion description: A Discussion in a repository. type: object @@ -15016,7 +15016,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &711 + sub_issues_summary: &713 title: Sub-issues Summary type: object properties: @@ -15143,7 +15143,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &712 + issue_dependencies_summary: &714 title: Issue Dependencies Summary type: object properties: @@ -16690,7 +16690,7 @@ paths: url: type: string format: uri - user: &720 + user: &722 title: Public User description: Public User type: object @@ -22576,7 +22576,7 @@ paths: parameters: - *78 - *124 - - &772 + - &774 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 @@ -22688,7 +22688,7 @@ paths: - *124 - *125 - *126 - - &773 + - &775 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -22696,7 +22696,7 @@ paths: schema: type: string - *129 - - &774 + - &776 name: sku description: The SKU to query for usage. in: query @@ -30237,12 +30237,12 @@ paths: required: - subject_digests examples: - default: &753 + default: &755 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &754 + withPredicateType: &756 value: subject_digests: - sha256:abc123 @@ -30300,7 +30300,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &755 + default: &757 value: attestations_subject_digests: - sha256:abc: @@ -42397,7 +42397,7 @@ paths: parameters: - *78 - *270 - - &736 + - &738 name: repo_name description: repo_name parameter in: path @@ -43456,7 +43456,7 @@ paths: - nuget - container - *78 - - &737 + - &739 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -43497,7 +43497,7 @@ paths: default: *277 '403': *29 '401': *25 - '400': &739 + '400': &741 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -45594,7 +45594,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &828 + properties: &830 id: type: number description: The unique identifier of the status update. @@ -45642,7 +45642,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &829 + required: &831 - id - node_id - created_at @@ -46532,7 +46532,7 @@ paths: - updated_at - project_url examples: - default: &759 + default: &761 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46709,7 +46709,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &760 + items: &762 type: object properties: name: @@ -46746,7 +46746,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &761 + iteration_configuration: &763 type: object description: The configuration for iteration fields. properties: @@ -46796,7 +46796,7 @@ paths: value: name: Due date data_type: date - single_select_field: &762 + single_select_field: &764 summary: Create a single select field value: name: Priority @@ -46823,7 +46823,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &763 + iteration_field: &765 summary: Create an iteration field value: name: Sprint @@ -46849,7 +46849,7 @@ paths: application/json: schema: *298 examples: - text_field: &764 + text_field: &766 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -46858,7 +46858,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: &765 + number_field: &767 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -46867,7 +46867,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: &766 + date_field: &768 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -46876,7 +46876,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: &767 + single_select_field: &769 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46910,7 +46910,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &768 + iteration_field: &770 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -46956,7 +46956,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *294 - - &769 + - &771 name: field_id description: The unique identifier of the field. in: path @@ -46971,7 +46971,7 @@ paths: application/json: schema: *298 examples: - default: &770 + default: &772 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -48168,7 +48168,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &750 + schema: &752 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -48345,7 +48345,7 @@ paths: parameters: - *294 - *78 - - &771 + - &773 name: view_number description: The number that identifies the project view. in: path @@ -50825,6 +50825,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 @@ -52418,6 +52455,29 @@ paths: required: false schema: type: boolean + - &678 + 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 + - &679 + 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 @@ -52444,14 +52504,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &678 + state: &680 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: &679 + resolution: &681 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -52568,8 +52628,8 @@ paths: pull request. ' - oneOf: &680 - - &682 + oneOf: &682 + - &684 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -52627,7 +52687,7 @@ paths: - blob_url - commit_sha - commit_url - - &683 + - &685 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. @@ -52682,7 +52742,7 @@ paths: - page_url - commit_sha - commit_url - - &684 + - &686 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -52702,7 +52762,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &685 + - &687 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -52722,7 +52782,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &686 + - &688 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -52742,7 +52802,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &687 + - &689 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -52756,7 +52816,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &688 + - &690 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -52770,7 +52830,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &689 + - &691 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -52784,7 +52844,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &690 + - &692 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. @@ -52804,7 +52864,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &691 + - &693 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. @@ -52824,7 +52884,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &692 + - &694 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. @@ -52844,7 +52904,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &693 + - &695 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. @@ -52864,7 +52924,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &694 + - &696 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. @@ -53383,7 +53443,7 @@ paths: application/json: schema: type: array - items: &698 + items: &700 description: A repository security advisory. type: object properties: @@ -53706,7 +53766,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &699 + default: &701 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -55570,7 +55630,7 @@ paths: application/json: schema: type: array - items: &714 + items: &716 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 @@ -55689,7 +55749,7 @@ paths: - type - url examples: - default: &715 + default: &717 value: - login: octocat id: 1 @@ -55775,7 +55835,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &716 + response-if-user-is-a-team-maintainer: &718 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -55840,7 +55900,7 @@ paths: application/json: schema: *355 examples: - response-if-users-membership-with-team-is-now-pending: &717 + response-if-users-membership-with-team-is-now-pending: &719 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -55954,7 +56014,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &718 + schema: &720 title: Team Repository description: A team's access to a repository. type: object @@ -56696,7 +56756,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: &719 + response-if-child-teams-exist: &721 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -62369,7 +62429,7 @@ paths: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &790 + properties: &792 url: type: string format: uri @@ -62454,7 +62514,7 @@ paths: nullable: true properties: *83 required: *84 - required: &791 + required: &793 - id - node_id - sha @@ -68574,7 +68634,7 @@ paths: check. type: array items: *93 - deployment: &783 + deployment: &785 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -69486,7 +69546,7 @@ paths: type: string format: date-time nullable: true - head_commit: &811 + head_commit: &813 title: Simple Commit description: A commit. type: object @@ -74229,14 +74289,14 @@ paths: type: integer machines: type: array - items: &725 + items: &727 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *479 required: *480 examples: - default: &726 + default: &728 value: total_count: 2 machines: @@ -77382,7 +77442,7 @@ paths: application/json: schema: type: array - items: &703 + items: &705 title: Status description: The status of a commit. type: object @@ -78995,7 +79055,7 @@ paths: items: type: object properties: - placeholder_id: &695 + placeholder_id: &697 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -85055,7 +85115,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &820 + last_response: &822 title: Hook Response type: object properties: @@ -86107,7 +86167,7 @@ paths: parameters: - *356 - *357 - - &748 + - &750 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -86692,7 +86752,7 @@ paths: type: array items: *558 examples: - default: &741 + default: &743 value: - id: 1 repository: @@ -101877,6 +101937,8 @@ paths: - *675 - *676 - *677 + - *678 + - *679 responses: '200': description: Response @@ -101884,7 +101946,7 @@ paths: application/json: schema: type: array - items: &681 + items: type: object properties: number: *188 @@ -101903,8 +101965,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *678 - resolution: *679 + state: *680 + resolution: *681 resolved_at: type: string format: date-time @@ -102010,7 +102072,7 @@ paths: pull request. ' - oneOf: *680 + oneOf: *682 nullable: true has_more_locations: type: boolean @@ -102183,7 +102245,176 @@ paths: description: Response content: application/json: - schema: *681 + schema: &683 + type: object + properties: + number: *188 + created_at: *189 + updated_at: + 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 + nullable: true + url: *191 + html_url: *192 + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: *680 + resolution: *681 + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + resolution_comment: + type: string + description: An optional comment to resolve an alert. + nullable: true + 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 + description: The provider of the secret that was detected. + nullable: true + provider_slug: + type: string + 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. + nullable: true + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected + secret. + nullable: true + push_protection_bypassed_by: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO + 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection + bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the detected secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple + repositories under the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert + is base64 encoded + nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: *682 + nullable: true + 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: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + closure_request_comment: + type: string + description: An optional comment from the closure request author. + nullable: true + closure_request_reviewer_comment: + type: string + description: An optional comment from the closure request reviewer. + nullable: true + closure_request_reviewer: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + metadata: &843 + 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: @@ -102210,6 +102441,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com '304': *37 '404': description: Repository is public, or secret scanning is disabled for the @@ -102247,8 +102481,8 @@ paths: schema: type: object properties: - state: *678 - resolution: *679 + state: *680 + resolution: *681 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -102292,7 +102526,7 @@ paths: description: Response content: application/json: - schema: *681 + schema: *683 examples: default: value: @@ -102337,6 +102571,9 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + metadata: + - key: owner_email + value: owner@example.com assigned_to: login: octocat id: 1 @@ -102404,7 +102641,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &842 + items: &845 type: object properties: type: @@ -102430,8 +102667,6 @@ paths: example: commit details: oneOf: - - *682 - - *683 - *684 - *685 - *686 @@ -102443,6 +102678,8 @@ paths: - *692 - *693 - *694 + - *695 + - *696 examples: default: value: @@ -102537,14 +102774,14 @@ paths: schema: type: object properties: - reason: &696 + reason: &698 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *695 + placeholder_id: *697 required: - reason - placeholder_id @@ -102561,7 +102798,7 @@ paths: schema: type: object properties: - reason: *696 + reason: *698 expire_at: type: string format: date-time @@ -102623,7 +102860,7 @@ paths: properties: incremental_scans: type: array - items: &697 + items: &699 description: Information on a single scan performed by secret scanning on the repository type: object @@ -102654,15 +102891,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *697 + items: *699 backfill_scans: type: array - items: *697 + items: *699 custom_pattern_backfill_scans: type: array items: allOf: - - *697 + - *699 - type: object properties: pattern_name: @@ -102675,7 +102912,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *697 + items: *699 examples: default: value: @@ -102785,9 +103022,9 @@ paths: application/json: schema: type: array - items: *698 + items: *700 examples: - default: *699 + default: *701 '400': *14 '404': *6 x-github: @@ -102971,9 +103208,9 @@ paths: description: Response content: application/json: - schema: *698 + schema: *700 examples: - default: &701 + default: &703 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -103317,7 +103554,7 @@ paths: description: Response content: application/json: - schema: *698 + schema: *700 examples: default: value: @@ -103472,15 +103709,15 @@ paths: parameters: - *356 - *357 - - *700 + - *702 responses: '200': description: Response content: application/json: - schema: *698 + schema: *700 examples: - default: *701 + default: *703 '403': *29 '404': *6 x-github: @@ -103506,7 +103743,7 @@ paths: parameters: - *356 - *357 - - *700 + - *702 requestBody: required: true content: @@ -103665,10 +103902,10 @@ paths: description: Response content: application/json: - schema: *698 + schema: *700 examples: - default: *701 - add_credit: *701 + default: *703 + add_credit: *703 '403': *29 '404': *6 '422': @@ -103708,7 +103945,7 @@ paths: parameters: - *356 - *357 - - *700 + - *702 responses: '202': *39 '400': *14 @@ -103737,7 +103974,7 @@ paths: parameters: - *356 - *357 - - *700 + - *702 responses: '202': description: Response @@ -103881,7 +104118,7 @@ paths: application/json: schema: type: array - items: &702 + items: &704 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104254,7 +104491,7 @@ paths: application/json: schema: type: array - items: *702 + items: *704 examples: default: value: @@ -104342,7 +104579,7 @@ paths: description: Response content: application/json: - schema: *703 + schema: *705 examples: default: value: @@ -104436,7 +104673,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &704 + schema: &706 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -104531,7 +104768,7 @@ paths: description: Response content: application/json: - schema: *704 + schema: *706 examples: default: value: @@ -104738,7 +104975,7 @@ paths: description: Response content: application/json: - schema: &705 + schema: &707 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -104750,7 +104987,7 @@ paths: required: - names examples: - default: &706 + default: &708 value: names: - octocat @@ -104805,9 +105042,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *707 examples: - default: *706 + default: *708 '404': *6 '422': *7 x-github: @@ -104830,7 +105067,7 @@ paths: parameters: - *356 - *357 - - &707 + - &709 name: per description: The time frame to display results for. in: query @@ -104859,7 +105096,7 @@ paths: example: 128 clones: type: array - items: &708 + items: &710 title: Traffic type: object properties: @@ -105100,7 +105337,7 @@ paths: parameters: - *356 - *357 - - *707 + - *709 responses: '200': description: Response @@ -105119,7 +105356,7 @@ paths: example: 3782 views: type: array - items: *708 + items: *710 required: - uniques - count @@ -105897,7 +106134,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &709 + text_matches: &711 title: Search Result Text Matches type: array items: @@ -106059,7 +106296,7 @@ paths: enum: - author-date - committer-date - - &710 + - &712 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 @@ -106187,7 +106424,7 @@ paths: type: number node_id: type: string - text_matches: *709 + text_matches: *711 required: - sha - node_id @@ -106379,7 +106616,7 @@ paths: - interactions - created - updated - - *710 + - *712 - *17 - *19 - name: advanced_search @@ -106493,8 +106730,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -106529,7 +106766,7 @@ paths: type: string format: date-time nullable: true - text_matches: *709 + text_matches: *711 pull_request: type: object properties: @@ -106845,7 +107082,7 @@ paths: enum: - created - updated - - *710 + - *712 - *17 - *19 responses: @@ -106889,7 +107126,7 @@ paths: nullable: true score: type: number - text_matches: *709 + text_matches: *711 required: - id - node_id @@ -106974,7 +107211,7 @@ paths: - forks - help-wanted-issues - updated - - *710 + - *712 - *17 - *19 responses: @@ -107222,7 +107459,7 @@ paths: - admin - pull - push - text_matches: *709 + text_matches: *711 temp_clone_token: type: string allow_merge_commit: @@ -107522,7 +107759,7 @@ paths: type: string format: uri nullable: true - text_matches: *709 + text_matches: *711 related: type: array nullable: true @@ -107713,7 +107950,7 @@ paths: - followers - repositories - joined - - *710 + - *712 - *17 - *19 responses: @@ -107817,7 +108054,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *709 + text_matches: *711 blog: type: string nullable: true @@ -107896,7 +108133,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &713 + - &715 name: team_id description: The unique identifier of the team. in: path @@ -107937,7 +108174,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *713 + - *715 requestBody: required: true content: @@ -108037,7 +108274,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *713 + - *715 responses: '204': description: Response @@ -108066,7 +108303,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *713 + - *715 - *17 - *19 responses: @@ -108106,7 +108343,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *713 + - *715 - name: role description: Filters members returned by their role in the team. in: query @@ -108127,9 +108364,9 @@ paths: application/json: schema: type: array - items: *714 + items: *716 examples: - default: *715 + default: *717 headers: Link: *70 '404': *6 @@ -108157,7 +108394,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *713 + - *715 - *74 responses: '204': @@ -108194,7 +108431,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *713 + - *715 - *74 responses: '204': @@ -108234,7 +108471,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *713 + - *715 - *74 responses: '204': @@ -108271,7 +108508,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *713 + - *715 - *74 responses: '200': @@ -108280,7 +108517,7 @@ paths: application/json: schema: *355 examples: - response-if-user-is-a-team-maintainer: *716 + response-if-user-is-a-team-maintainer: *718 '404': *6 x-github: githubCloudOnly: false @@ -108313,7 +108550,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *713 + - *715 - *74 requestBody: required: false @@ -108341,7 +108578,7 @@ paths: application/json: schema: *355 examples: - response-if-users-membership-with-team-is-now-pending: *717 + response-if-users-membership-with-team-is-now-pending: *719 '403': description: Forbidden if team synchronization is set up '422': @@ -108375,7 +108612,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *713 + - *715 - *74 responses: '204': @@ -108403,7 +108640,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *713 + - *715 - *17 - *19 responses: @@ -108445,7 +108682,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *713 + - *715 - *356 - *357 responses: @@ -108453,7 +108690,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *718 + schema: *720 examples: alternative-response-with-extra-repository-information: value: @@ -108610,7 +108847,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *713 + - *715 - *356 - *357 requestBody: @@ -108662,7 +108899,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *713 + - *715 - *356 - *357 responses: @@ -108689,7 +108926,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *713 + - *715 - *17 - *19 responses: @@ -108701,7 +108938,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: *719 + response-if-child-teams-exist: *721 headers: Link: *70 '404': *6 @@ -108734,7 +108971,7 @@ paths: application/json: schema: oneOf: - - &721 + - &723 title: Private User description: Private User type: object @@ -108937,7 +109174,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *720 + - *722 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -109090,7 +109327,7 @@ paths: description: Response content: application/json: - schema: *721 + schema: *723 examples: default: value: @@ -109488,7 +109725,7 @@ paths: type: integer secrets: type: array - items: &722 + items: &724 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -109604,7 +109841,7 @@ paths: description: Response content: application/json: - schema: *722 + schema: *724 examples: default: value: @@ -110017,7 +110254,7 @@ paths: description: Response content: application/json: - schema: &723 + schema: &725 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -110058,7 +110295,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &724 + default: &726 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -110103,9 +110340,9 @@ paths: description: Response content: application/json: - schema: *723 + schema: *725 examples: - default: *724 + default: *726 '404': *6 x-github: githubCloudOnly: false @@ -110142,9 +110379,9 @@ paths: type: integer machines: type: array - items: *725 + items: *727 examples: - default: *726 + default: *728 '304': *37 '500': *55 '401': *25 @@ -111083,7 +111320,7 @@ paths: type: array items: *276 examples: - default: &738 + default: &740 value: - id: 197 name: hello_docker @@ -111184,7 +111421,7 @@ paths: application/json: schema: type: array - items: &727 + items: &729 title: Email description: Email type: object @@ -111249,9 +111486,9 @@ paths: application/json: schema: type: array - items: *727 + items: *729 examples: - default: &740 + default: &742 value: - email: octocat@github.com verified: true @@ -111326,7 +111563,7 @@ paths: application/json: schema: type: array - items: *727 + items: *729 examples: default: value: @@ -111582,7 +111819,7 @@ paths: application/json: schema: type: array - items: &728 + items: &730 title: GPG Key description: A unique encryption key type: object @@ -111713,7 +111950,7 @@ paths: - subkeys - revoked examples: - default: &757 + default: &759 value: - id: 3 name: Octocat's GPG Key @@ -111798,9 +112035,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *730 examples: - default: &729 + default: &731 value: id: 3 name: Octocat's GPG Key @@ -111857,7 +112094,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &730 + - &732 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -111869,9 +112106,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *730 examples: - default: *729 + default: *731 '404': *6 '304': *37 '403': *29 @@ -111894,7 +112131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *730 + - *732 responses: '204': description: Response @@ -112361,7 +112598,7 @@ paths: application/json: schema: type: array - items: &731 + items: &733 title: Key description: Key type: object @@ -112462,9 +112699,9 @@ paths: description: Response content: application/json: - schema: *731 + schema: *733 examples: - default: &732 + default: &734 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -112503,9 +112740,9 @@ paths: description: Response content: application/json: - schema: *731 + schema: *733 examples: - default: *732 + default: *734 '404': *6 '304': *37 '403': *29 @@ -112561,7 +112798,7 @@ paths: application/json: schema: type: array - items: &733 + items: &735 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -112629,7 +112866,7 @@ paths: - account - plan examples: - default: &734 + default: &736 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -112691,9 +112928,9 @@ paths: application/json: schema: type: array - items: *733 + items: *735 examples: - default: *734 + default: *736 headers: Link: *70 '304': *37 @@ -112936,7 +113173,7 @@ paths: application/json: schema: *267 examples: - default: &735 + default: &737 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -112985,7 +113222,7 @@ paths: application/json: schema: *267 examples: - default: *735 + default: *737 '403': *29 '404': *6 '422': *15 @@ -113710,7 +113947,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *270 - - *736 + - *738 responses: '204': description: Response @@ -113843,7 +114080,7 @@ paths: - docker - nuget - container - - *737 + - *739 - *19 - *17 responses: @@ -113855,8 +114092,8 @@ paths: type: array items: *276 examples: - default: *738 - '400': *739 + default: *740 + '400': *741 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113885,7 +114122,7 @@ paths: application/json: schema: *276 examples: - default: &758 + default: &760 value: id: 40201 name: octo-name @@ -114247,9 +114484,9 @@ paths: application/json: schema: type: array - items: *727 + items: *729 examples: - default: *740 + default: *742 headers: Link: *70 '304': *37 @@ -114362,7 +114599,7 @@ paths: type: array items: *82 examples: - default: &747 + default: &749 summary: Default response value: - id: 1296269 @@ -114714,7 +114951,7 @@ paths: type: array items: *558 examples: - default: *741 + default: *743 headers: Link: *70 '304': *37 @@ -114799,7 +115036,7 @@ paths: application/json: schema: type: array - items: &742 + items: &744 title: Social account description: Social media account type: object @@ -114814,7 +115051,7 @@ paths: - provider - url examples: - default: &743 + default: &745 value: - provider: twitter url: https://twitter.com/github @@ -114876,9 +115113,9 @@ paths: application/json: schema: type: array - items: *742 + items: *744 examples: - default: *743 + default: *745 '422': *15 '304': *37 '404': *6 @@ -114965,7 +115202,7 @@ paths: application/json: schema: type: array - items: &744 + items: &746 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -114985,7 +115222,7 @@ paths: - title - created_at examples: - default: &775 + default: &777 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -115049,9 +115286,9 @@ paths: description: Response content: application/json: - schema: *744 + schema: *746 examples: - default: &745 + default: &747 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -115081,7 +115318,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: - - &746 + - &748 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -115093,9 +115330,9 @@ paths: description: Response content: application/json: - schema: *744 + schema: *746 examples: - default: *745 + default: *747 '404': *6 '304': *37 '403': *29 @@ -115118,7 +115355,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: - - *746 + - *748 responses: '204': description: Response @@ -115147,7 +115384,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &776 + - &778 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 @@ -115172,11 +115409,11 @@ paths: type: array items: *82 examples: - default-response: *747 + default-response: *749 application/vnd.github.v3.star+json: schema: type: array - items: &777 + items: &779 title: Starred Repository description: Starred Repository type: object @@ -115545,10 +115782,10 @@ paths: application/json: schema: oneOf: - - *721 - - *720 + - *723 + - *722 examples: - default-response: &751 + default-response: &753 summary: Default response value: login: octocat @@ -115583,7 +115820,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &752 + response-with-git-hub-plan-information: &754 summary: Response with GitHub plan information value: login: octocat @@ -115640,7 +115877,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &749 + - &751 name: user_id description: The unique identifier of the user. in: path @@ -115706,7 +115943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *748 + - *750 - *17 responses: '200': @@ -115741,7 +115978,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *749 + - *751 - *294 requestBody: required: true @@ -115813,7 +116050,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *750 + schema: *752 examples: table_view: summary: Response for creating a table view @@ -115865,11 +116102,11 @@ paths: application/json: schema: oneOf: - - *721 - - *720 + - *723 + - *722 examples: - default-response: *751 - response-with-git-hub-plan-information: *752 + default-response: *753 + response-with-git-hub-plan-information: *754 '404': *6 x-github: githubCloudOnly: false @@ -115919,8 +116156,8 @@ paths: required: - subject_digests examples: - default: *753 - withPredicateType: *754 + default: *755 + withPredicateType: *756 responses: '200': description: Response @@ -115973,7 +116210,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *755 + default: *757 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -116488,7 +116725,7 @@ paths: application/json: schema: *204 examples: - default: &756 + default: &758 summary: Example response for a user copilot space value: id: 42 @@ -116589,7 +116826,7 @@ paths: application/json: schema: *204 examples: - default: *756 + default: *758 '403': *29 '404': *6 x-github: @@ -116712,7 +116949,7 @@ paths: application/json: schema: *204 examples: - default: *756 + default: *758 '403': *29 '404': *6 '422': *15 @@ -117480,7 +117717,7 @@ paths: type: array items: *276 examples: - default: *738 + default: *740 '403': *29 '401': *25 x-github: @@ -117864,9 +118101,9 @@ paths: application/json: schema: type: array - items: *728 + items: *730 examples: - default: *757 + default: *759 headers: Link: *70 x-github: @@ -118094,7 +118331,7 @@ paths: - docker - nuget - container - - *737 + - *739 - *74 - *19 - *17 @@ -118107,10 +118344,10 @@ paths: type: array items: *276 examples: - default: *738 + default: *740 '403': *29 '401': *25 - '400': *739 + '400': *741 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118140,7 +118377,7 @@ paths: application/json: schema: *276 examples: - default: *758 + default: *760 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118489,7 +118726,7 @@ paths: type: array items: *298 examples: - default: *759 + default: *761 headers: Link: *70 '304': *37 @@ -118549,7 +118786,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *760 + items: *762 required: - name - data_type @@ -118565,7 +118802,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *761 + iteration_configuration: *763 required: - name - data_type @@ -118587,8 +118824,8 @@ paths: value: name: Due date data_type: date - single_select_field: *762 - iteration_field: *763 + single_select_field: *764 + iteration_field: *765 responses: '201': description: Response @@ -118596,11 +118833,11 @@ paths: application/json: schema: *298 examples: - text_field: *764 - number_field: *765 - date_field: *766 - single_select_field: *767 - iteration_field: *768 + text_field: *766 + number_field: *767 + date_field: *768 + single_select_field: *769 + iteration_field: *770 '304': *37 '403': *29 '401': *25 @@ -118622,7 +118859,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *294 - - *769 + - *771 - *74 responses: '200': @@ -118631,7 +118868,7 @@ paths: application/json: schema: *298 examples: - default: *770 + default: *772 headers: Link: *70 '304': *37 @@ -118985,7 +119222,7 @@ paths: parameters: - *294 - *74 - - *771 + - *773 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -119524,7 +119761,7 @@ paths: parameters: - *74 - *124 - - *772 + - *774 - *126 responses: '200': @@ -119623,9 +119860,9 @@ paths: - *124 - *125 - *126 - - *773 + - *775 - *129 - - *774 + - *776 responses: '200': description: Response when getting a billing usage summary @@ -119759,9 +119996,9 @@ paths: application/json: schema: type: array - items: *742 + items: *744 examples: - default: *743 + default: *745 headers: Link: *70 x-github: @@ -119791,9 +120028,9 @@ paths: application/json: schema: type: array - items: *744 + items: *746 examples: - default: *775 + default: *777 headers: Link: *70 x-github: @@ -119818,7 +120055,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *74 - - *776 + - *778 - *62 - *17 - *19 @@ -119830,11 +120067,11 @@ paths: schema: anyOf: - type: array - items: *777 + items: *779 - type: array items: *82 examples: - default-response: *747 + default-response: *749 headers: Link: *70 x-github: @@ -119993,7 +120230,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &778 + enterprise: &780 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -120051,7 +120288,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &779 + installation: &781 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -120070,7 +120307,7 @@ x-webhooks: required: - id - node_id - organization: &780 + organization: &782 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -120130,13 +120367,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &781 + repository: &783 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &813 + properties: &815 id: description: Unique identifier of the repository example: 42 @@ -120831,7 +121068,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &814 + required: &816 - archive_url - assignees_url - blobs_url @@ -120905,7 +121142,7 @@ x-webhooks: - watchers_count - created_at - updated_at - x-github-breaking-changes: &815 + x-github-breaking-changes: &817 - changeset: remove_use_squash_pr_title_as_default patch: properties: @@ -120996,10 +121233,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -121075,11 +121312,11 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 - rule: &782 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 + rule: &784 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) @@ -121302,11 +121539,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 - rule: *782 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 + rule: *784 sender: *4 required: - action @@ -121489,11 +121726,11 @@ x-webhooks: - everyone required: - from - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 - rule: *782 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 + rule: *784 sender: *4 required: - action @@ -121577,7 +121814,7 @@ x-webhooks: type: string enum: - completed - check_run: &784 + check_run: &786 title: CheckRun description: A check performed on the code of a given code change type: object @@ -121668,7 +121905,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *783 + deployment: *785 details_url: example: https://example.com type: string @@ -121753,10 +121990,10 @@ x-webhooks: - output - app - pull_requests - installation: *779 - enterprise: *778 - organization: *780 - repository: *781 + installation: *781 + enterprise: *780 + organization: *782 + repository: *783 sender: *4 required: - check_run @@ -122147,11 +122384,11 @@ x-webhooks: type: string enum: - created - check_run: *784 - installation: *779 - enterprise: *778 - organization: *780 - repository: *781 + check_run: *786 + installation: *781 + enterprise: *780 + organization: *782 + repository: *783 sender: *4 required: - check_run @@ -122545,11 +122782,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *784 - installation: *779 - enterprise: *778 - organization: *780 - repository: *781 + check_run: *786 + installation: *781 + enterprise: *780 + organization: *782 + repository: *783 requested_action: description: The action requested by the user. type: object @@ -122952,11 +123189,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *784 - installation: *779 - enterprise: *778 - organization: *780 - repository: *781 + check_run: *786 + installation: *781 + enterprise: *780 + organization: *782 + repository: *783 sender: *4 required: - check_run @@ -123926,10 +124163,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -124628,10 +124865,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -125324,10 +125561,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -125638,20 +125875,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &785 + commit_oid: &787 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: *778 - installation: *779 - organization: *780 - ref: &786 + enterprise: *780 + installation: *781 + organization: *782 + ref: &788 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: *781 + repository: *783 sender: *4 required: - action @@ -126046,12 +126283,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *785 - enterprise: *778 - installation: *779 - organization: *780 - ref: *786 - repository: *781 + commit_oid: *787 + enterprise: *780 + installation: *781 + organization: *782 + ref: *788 + repository: *783 sender: *4 required: - action @@ -126317,12 +126554,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *785 - enterprise: *778 - installation: *779 - organization: *780 - ref: *786 - repository: *781 + commit_oid: *787 + enterprise: *780 + installation: *781 + organization: *782 + ref: *788 + repository: *783 sender: *4 required: - action @@ -126654,12 +126891,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *785 - enterprise: *778 - installation: *779 - organization: *780 - ref: *786 - repository: *781 + commit_oid: *787 + enterprise: *780 + installation: *781 + organization: *782 + ref: *788 + repository: *783 sender: *4 required: - action @@ -126933,16 +127170,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 ref: 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 nullable: true - repository: *781 + repository: *783 sender: *4 required: - action @@ -127179,12 +127416,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *785 - enterprise: *778 - installation: *779 - organization: *780 - ref: *786 - repository: *781 + commit_oid: *787 + enterprise: *780 + installation: *781 + organization: *782 + ref: *788 + repository: *783 sender: *4 required: - action @@ -127495,10 +127732,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -127753,10 +127990,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -127836,18 +128073,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *780 - pusher_type: &787 + organization: *782 + pusher_type: &789 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &788 + ref: &790 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -127857,7 +128094,7 @@ x-webhooks: enum: - tag - branch - repository: *781 + repository: *783 sender: *4 required: - ref @@ -127940,9 +128177,9 @@ x-webhooks: enum: - created definition: *306 - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 sender: *4 required: - action @@ -128027,9 +128264,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 sender: *4 required: - action @@ -128107,9 +128344,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *306 - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 sender: *4 required: - action @@ -128187,9 +128424,9 @@ x-webhooks: enum: - updated definition: *306 - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 sender: *4 required: - action @@ -128266,10 +128503,10 @@ x-webhooks: type: string enum: - updated - enterprise: *778 - installation: *779 - repository: *781 - organization: *780 + enterprise: *780 + installation: *781 + repository: *783 + organization: *782 sender: *4 new_property_values: type: array @@ -128354,18 +128591,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *778 - installation: *779 - organization: *780 - pusher_type: *787 - ref: *788 + enterprise: *780 + installation: *781 + organization: *782 + pusher_type: *789 + ref: *790 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *781 + repository: *783 sender: *4 required: - ref @@ -128446,10 +128683,10 @@ x-webhooks: enum: - assignees_changed alert: *514 - installation: *779 - organization: *780 - enterprise: *778 - repository: *781 + installation: *781 + organization: *782 + enterprise: *780 + repository: *783 sender: *4 required: - action @@ -128530,10 +128767,10 @@ x-webhooks: enum: - auto_dismissed alert: *514 - installation: *779 - organization: *780 - enterprise: *778 - repository: *781 + installation: *781 + organization: *782 + enterprise: *780 + repository: *783 sender: *4 required: - action @@ -128615,10 +128852,10 @@ x-webhooks: enum: - auto_reopened alert: *514 - installation: *779 - organization: *780 - enterprise: *778 - repository: *781 + installation: *781 + organization: *782 + enterprise: *780 + repository: *783 sender: *4 required: - action @@ -128700,10 +128937,10 @@ x-webhooks: enum: - created alert: *514 - installation: *779 - organization: *780 - enterprise: *778 - repository: *781 + installation: *781 + organization: *782 + enterprise: *780 + repository: *783 sender: *4 required: - action @@ -128783,10 +129020,10 @@ x-webhooks: enum: - dismissed alert: *514 - installation: *779 - organization: *780 - enterprise: *778 - repository: *781 + installation: *781 + organization: *782 + enterprise: *780 + repository: *783 sender: *4 required: - action @@ -128866,10 +129103,10 @@ x-webhooks: enum: - fixed alert: *514 - installation: *779 - organization: *780 - enterprise: *778 - repository: *781 + installation: *781 + organization: *782 + enterprise: *780 + repository: *783 sender: *4 required: - action @@ -128950,10 +129187,10 @@ x-webhooks: enum: - reintroduced alert: *514 - installation: *779 - organization: *780 - enterprise: *778 - repository: *781 + installation: *781 + organization: *782 + enterprise: *780 + repository: *783 sender: *4 required: - action @@ -129033,10 +129270,10 @@ x-webhooks: enum: - reopened alert: *514 - installation: *779 - organization: *780 - enterprise: *778 - repository: *781 + installation: *781 + organization: *782 + enterprise: *780 + repository: *783 sender: *4 required: - action @@ -129113,9 +129350,9 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - key: &789 + enterprise: *780 + installation: *781 + key: &791 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -129151,8 +129388,8 @@ x-webhooks: - verified - created_at - read_only - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -129229,11 +129466,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - key: *789 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + key: *791 + organization: *782 + repository: *783 sender: *4 required: - action @@ -129789,12 +130026,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 - workflow: &795 + workflow: &797 title: Workflow type: object nullable: true @@ -130535,15 +130772,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *790 - required: *791 + properties: *792 + required: *793 nullable: true pull_requests: type: array items: *628 - repository: *781 - organization: *780 - installation: *779 + repository: *783 + organization: *782 + installation: *781 sender: *4 responses: '200': @@ -130614,7 +130851,7 @@ x-webhooks: type: string enum: - approved - approver: &792 + approver: &794 type: object properties: avatar_url: @@ -130657,11 +130894,11 @@ x-webhooks: type: string comment: type: string - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 - reviewers: &793 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 + reviewers: &795 type: array items: type: object @@ -130740,7 +130977,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &794 + workflow_job_run: &796 type: object properties: conclusion: @@ -131471,18 +131708,18 @@ x-webhooks: type: string enum: - rejected - approver: *792 + approver: *794 comment: type: string - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 - reviewers: *793 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 + reviewers: *795 sender: *4 since: type: string - workflow_job_run: *794 + workflow_job_run: *796 workflow_job_runs: type: array items: @@ -132186,13 +132423,13 @@ x-webhooks: type: string enum: - requested - enterprise: *778 + enterprise: *780 environment: type: string - installation: *779 - organization: *780 - repository: *781 - requestor: &800 + installation: *781 + organization: *782 + repository: *783 + requestor: &802 title: User type: object nullable: true @@ -134081,12 +134318,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 - workflow: *795 + workflow: *797 workflow_run: title: Deployment Workflow Run type: object @@ -134766,7 +135003,7 @@ x-webhooks: type: string enum: - answered - answer: &798 + answer: &800 type: object properties: author_association: @@ -134923,11 +135160,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -135054,11 +135291,11 @@ x-webhooks: - from required: - category - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -135141,11 +135378,11 @@ x-webhooks: type: string enum: - closed - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -135227,7 +135464,7 @@ x-webhooks: type: string enum: - created - comment: &797 + comment: &799 type: object properties: author_association: @@ -135384,11 +135621,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -135471,12 +135708,12 @@ x-webhooks: type: string enum: - deleted - comment: *797 - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + comment: *799 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -135571,12 +135808,12 @@ x-webhooks: - from required: - body - comment: *797 - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + comment: *799 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -135660,11 +135897,11 @@ x-webhooks: type: string enum: - created - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -135746,11 +135983,11 @@ x-webhooks: type: string enum: - deleted - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -135850,11 +136087,11 @@ x-webhooks: type: string required: - from - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -135936,10 +136173,10 @@ x-webhooks: type: string enum: - labeled - discussion: *796 - enterprise: *778 - installation: *779 - label: &799 + discussion: *798 + enterprise: *780 + installation: *781 + label: &801 title: Label type: object properties: @@ -135971,8 +136208,8 @@ x-webhooks: - color - default - description - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -136055,11 +136292,11 @@ x-webhooks: type: string enum: - locked - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -136141,11 +136378,11 @@ x-webhooks: type: string enum: - pinned - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -136227,11 +136464,11 @@ x-webhooks: type: string enum: - reopened - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -136316,16 +136553,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *796 - new_repository: *781 + new_discussion: *798 + new_repository: *783 required: - new_discussion - new_repository - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -136408,10 +136645,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *796 - old_answer: *798 - organization: *780 - repository: *781 + discussion: *798 + old_answer: *800 + organization: *782 + repository: *783 sender: *4 required: - action @@ -136493,12 +136730,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *796 - enterprise: *778 - installation: *779 - label: *799 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + label: *801 + organization: *782 + repository: *783 sender: *4 required: - action @@ -136581,11 +136818,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -136667,11 +136904,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *796 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + discussion: *798 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -136744,7 +136981,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *778 + enterprise: *780 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -137404,9 +137641,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *779 - organization: *780 - repository: *781 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - forkee @@ -137552,9 +137789,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 pages: description: The pages that were updated. type: array @@ -137591,7 +137828,7 @@ x-webhooks: - action - sha - html_url - repository: *781 + repository: *783 sender: *4 required: - pages @@ -137667,10 +137904,10 @@ x-webhooks: type: string enum: - created - enterprise: *778 + enterprise: *780 installation: *22 - organization: *780 - repositories: &801 + organization: *782 + repositories: &803 description: An array of repository objects that the installation can access. type: array @@ -137696,8 +137933,8 @@ x-webhooks: - name - full_name - private - repository: *781 - requester: *800 + repository: *783 + requester: *802 sender: *4 required: - action @@ -137772,11 +138009,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 + enterprise: *780 installation: *22 - organization: *780 - repositories: *801 - repository: *781 + organization: *782 + repositories: *803 + repository: *783 requester: nullable: true sender: *4 @@ -137852,11 +138089,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *778 + enterprise: *780 installation: *22 - organization: *780 - repositories: *801 - repository: *781 + organization: *782 + repositories: *803 + repository: *783 requester: nullable: true sender: *4 @@ -137932,10 +138169,10 @@ x-webhooks: type: string enum: - added - enterprise: *778 + enterprise: *780 installation: *22 - organization: *780 - repositories_added: &802 + organization: *782 + repositories_added: &804 description: An array of repository objects, which were added to the installation. type: array @@ -137981,15 +138218,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *781 - repository_selection: &803 + repository: *783 + repository_selection: &805 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *800 + requester: *802 sender: *4 required: - action @@ -138068,10 +138305,10 @@ x-webhooks: type: string enum: - removed - enterprise: *778 + enterprise: *780 installation: *22 - organization: *780 - repositories_added: *802 + organization: *782 + repositories_added: *804 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -138098,9 +138335,9 @@ x-webhooks: - name - full_name - private - repository: *781 - repository_selection: *803 - requester: *800 + repository: *783 + repository_selection: *805 + requester: *802 sender: *4 required: - action @@ -138179,11 +138416,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *778 + enterprise: *780 installation: *22 - organization: *780 - repositories: *801 - repository: *781 + organization: *782 + repositories: *803 + repository: *783 requester: nullable: true sender: *4 @@ -138361,10 +138598,10 @@ x-webhooks: type: string required: - from - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 target_type: type: string @@ -138443,11 +138680,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *778 + enterprise: *780 installation: *22 - organization: *780 - repositories: *801 - repository: *781 + organization: *782 + repositories: *803 + repository: *783 requester: nullable: true sender: *4 @@ -138714,8 +138951,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -139504,8 +139741,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139854,8 +140091,8 @@ x-webhooks: - state - locked - assignee - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -139935,7 +140172,7 @@ x-webhooks: type: string enum: - deleted - comment: &804 + comment: &806 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -140115,8 +140352,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -140901,8 +141138,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141253,8 +141490,8 @@ x-webhooks: - state - locked - assignee - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -141334,7 +141571,7 @@ x-webhooks: type: string enum: - edited - changes: &834 + changes: &836 description: The changes to the comment. type: object properties: @@ -141346,9 +141583,9 @@ x-webhooks: type: string required: - from - comment: *804 - enterprise: *778 - installation: *779 + comment: *806 + enterprise: *780 + installation: *781 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -142136,8 +142373,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142486,8 +142723,8 @@ x-webhooks: - state - locked - assignee - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -142568,9 +142805,9 @@ x-webhooks: type: string enum: - pinned - comment: *804 - enterprise: *778 - installation: *779 + comment: *806 + enterprise: *780 + installation: *781 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -143360,8 +143597,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143712,8 +143949,8 @@ x-webhooks: - state - locked - assignee - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -143793,9 +144030,9 @@ x-webhooks: type: string enum: - unpinned - comment: *804 - enterprise: *778 - installation: *779 + comment: *806 + enterprise: *780 + installation: *781 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -144585,8 +144822,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144937,8 +145174,8 @@ x-webhooks: - state - locked - assignee - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -145027,9 +145264,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *779 - organization: *780 - repository: *781 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -145118,9 +145355,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *779 - organization: *780 - repository: *781 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -145208,9 +145445,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *779 - organization: *780 - repository: *781 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -145299,9 +145536,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *779 - organization: *780 - repository: *781 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -145381,10 +145618,10 @@ x-webhooks: type: string enum: - assigned - assignee: *800 - enterprise: *778 - installation: *779 - issue: &805 + assignee: *802 + enterprise: *780 + installation: *781 + issue: &807 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -146176,8 +146413,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -146297,8 +146534,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -146378,8 +146615,8 @@ x-webhooks: type: string enum: - closed - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -147176,8 +147413,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -147432,8 +147669,8 @@ x-webhooks: required: - state - closed_at - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -147512,8 +147749,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148301,8 +148538,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -148421,8 +148658,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -148501,8 +148738,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149312,8 +149549,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -149411,7 +149648,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &806 + milestone: &808 title: Milestone description: A collection of related issues and pull requests. type: object @@ -149549,8 +149786,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -149649,8 +149886,8 @@ x-webhooks: type: string required: - from - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150442,8 +150679,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -150563,9 +150800,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *799 - organization: *780 - repository: *781 + label: *801 + organization: *782 + repository: *783 sender: *4 required: - action @@ -150645,9 +150882,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *778 - installation: *779 - issue: *805 + enterprise: *780 + installation: *781 + issue: *807 issue_field: type: object description: The issue field whose value was set or updated on the @@ -150801,8 +151038,8 @@ x-webhooks: - id required: - from - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -150882,9 +151119,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *778 - installation: *779 - issue: *805 + enterprise: *780 + installation: *781 + issue: *807 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -150965,8 +151202,8 @@ x-webhooks: nullable: true required: - id - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -151046,8 +151283,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151838,8 +152075,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -151959,9 +152196,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *799 - organization: *780 - repository: *781 + label: *801 + organization: *782 + repository: *783 sender: *4 required: - action @@ -152041,8 +152278,8 @@ x-webhooks: type: string enum: - locked - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152857,8 +153094,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -152955,8 +153192,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -153035,8 +153272,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153845,8 +154082,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -153943,9 +154180,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *806 - organization: *780 - repository: *781 + milestone: *808 + organization: *782 + repository: *783 sender: *4 required: - action @@ -154808,8 +155045,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -155393,8 +155630,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -156178,8 +156415,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -156306,8 +156543,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -156387,9 +156624,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *778 - installation: *779 - issue: &807 + enterprise: *780 + installation: *781 + issue: &809 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -157175,8 +157412,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -157295,8 +157532,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -157375,8 +157612,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -158189,8 +158426,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -158288,8 +158525,8 @@ x-webhooks: user_view_type: type: string type: *258 - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -159158,8 +159395,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -159757,11 +159994,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *778 - installation: *779 - issue: *807 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + issue: *809 + organization: *782 + repository: *783 sender: *4 required: - action @@ -159841,12 +160078,12 @@ x-webhooks: type: string enum: - typed - enterprise: *778 - installation: *779 - issue: *805 + enterprise: *780 + installation: *781 + issue: *807 type: *258 - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -159927,7 +160164,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &837 + assignee: &839 title: User type: object nullable: true @@ -159997,11 +160234,11 @@ x-webhooks: required: - login - id - enterprise: *778 - installation: *779 - issue: *805 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + issue: *807 + organization: *782 + repository: *783 sender: *4 required: - action @@ -160080,12 +160317,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *778 - installation: *779 - issue: *805 - label: *799 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + issue: *807 + label: *801 + organization: *782 + repository: *783 sender: *4 required: - action @@ -160165,8 +160402,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -160979,8 +161216,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *711 - issue_dependencies_summary: *712 + sub_issues_summary: *713 + issue_dependencies_summary: *714 issue_field_values: type: array items: *576 @@ -161077,8 +161314,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -161158,11 +161395,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *778 - installation: *779 - issue: *807 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + issue: *809 + organization: *782 + repository: *783 sender: *4 required: - action @@ -161241,12 +161478,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *778 - installation: *779 - issue: *805 + enterprise: *780 + installation: *781 + issue: *807 type: *258 - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -161326,11 +161563,11 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - label: *799 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + label: *801 + organization: *782 + repository: *783 sender: *4 required: - action @@ -161408,11 +161645,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - label: *799 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + label: *801 + organization: *782 + repository: *783 sender: *4 required: - action @@ -161522,11 +161759,11 @@ x-webhooks: type: string required: - from - enterprise: *778 - installation: *779 - label: *799 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + label: *801 + organization: *782 + repository: *783 sender: *4 required: - action @@ -161608,9 +161845,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *778 - installation: *779 - marketplace_purchase: &808 + enterprise: *780 + installation: *781 + marketplace_purchase: &810 title: Marketplace Purchase type: object required: @@ -161693,8 +161930,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *780 - previous_marketplace_purchase: &809 + organization: *782 + previous_marketplace_purchase: &811 title: Marketplace Purchase type: object properties: @@ -161774,7 +162011,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *781 + repository: *783 sender: *4 required: - action @@ -161854,10 +162091,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *778 - installation: *779 - marketplace_purchase: *808 - organization: *780 + enterprise: *780 + installation: *781 + marketplace_purchase: *810 + organization: *782 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161940,7 +162177,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *781 + repository: *783 sender: *4 required: - action @@ -162022,10 +162259,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *778 - installation: *779 - marketplace_purchase: *808 - organization: *780 + enterprise: *780 + installation: *781 + marketplace_purchase: *810 + organization: *782 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -162107,7 +162344,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *781 + repository: *783 sender: *4 required: - action @@ -162188,8 +162425,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 marketplace_purchase: title: Marketplace Purchase type: object @@ -162271,9 +162508,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *780 - previous_marketplace_purchase: *809 - repository: *781 + organization: *782 + previous_marketplace_purchase: *811 + repository: *783 sender: *4 required: - action @@ -162353,12 +162590,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *778 - installation: *779 - marketplace_purchase: *808 - organization: *780 - previous_marketplace_purchase: *809 - repository: *781 + enterprise: *780 + installation: *781 + marketplace_purchase: *810 + organization: *782 + previous_marketplace_purchase: *811 + repository: *783 sender: *4 required: - action @@ -162460,11 +162697,11 @@ x-webhooks: type: string required: - to - enterprise: *778 - installation: *779 - member: *800 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + member: *802 + organization: *782 + repository: *783 sender: *4 required: - action @@ -162564,11 +162801,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *778 - installation: *779 - member: *800 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + member: *802 + organization: *782 + repository: *783 sender: *4 required: - action @@ -162647,11 +162884,11 @@ x-webhooks: type: string enum: - removed - enterprise: *778 - installation: *779 - member: *800 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + member: *802 + organization: *782 + repository: *783 sender: *4 required: - action @@ -162729,11 +162966,11 @@ x-webhooks: type: string enum: - added - enterprise: *778 - installation: *779 - member: *800 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + member: *802 + organization: *782 + repository: *783 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162809,7 +163046,7 @@ x-webhooks: required: - login - id - team: &810 + team: &812 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -163032,11 +163269,11 @@ x-webhooks: type: string enum: - removed - enterprise: *778 - installation: *779 - member: *800 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + member: *802 + organization: *782 + repository: *783 scope: description: The scope of the membership. Currently, can only be `team`. @@ -163113,7 +163350,7 @@ x-webhooks: required: - login - id - team: *810 + team: *812 required: - action - scope @@ -163195,8 +163432,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *779 - merge_group: &812 + installation: *781 + merge_group: &814 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -163215,15 +163452,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *811 + head_commit: *813 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -163309,10 +163546,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *779 - merge_group: *812 - organization: *780 - repository: *781 + installation: *781 + merge_group: *814 + organization: *782 + repository: *783 sender: *4 required: - action @@ -163385,7 +163622,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 + enterprise: *780 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -163494,17 +163731,17 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *779 - organization: *780 + installation: *781 + organization: *782 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *813 - required: *814 - x-github-breaking-changes: *815 + properties: *815 + required: *816 + x-github-breaking-changes: *817 nullable: true sender: *4 required: @@ -163585,11 +163822,11 @@ x-webhooks: type: string enum: - closed - enterprise: *778 - installation: *779 - milestone: *806 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + milestone: *808 + organization: *782 + repository: *783 sender: *4 required: - action @@ -163668,9 +163905,9 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - milestone: &816 + enterprise: *780 + installation: *781 + milestone: &818 title: Milestone description: A collection of related issues and pull requests. type: object @@ -163807,8 +164044,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -163887,11 +164124,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - milestone: *806 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + milestone: *808 + organization: *782 + repository: *783 sender: *4 required: - action @@ -164001,11 +164238,11 @@ x-webhooks: type: string required: - from - enterprise: *778 - installation: *779 - milestone: *806 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + milestone: *808 + organization: *782 + repository: *783 sender: *4 required: - action @@ -164085,11 +164322,11 @@ x-webhooks: type: string enum: - opened - enterprise: *778 - installation: *779 - milestone: *816 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + milestone: *818 + organization: *782 + repository: *783 sender: *4 required: - action @@ -164168,11 +164405,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *800 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + blocked_user: *802 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -164251,11 +164488,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *800 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + blocked_user: *802 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -164334,9 +164571,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - membership: &817 + enterprise: *780 + installation: *781 + membership: &819 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -164443,8 +164680,8 @@ x-webhooks: - role - organization_url - user - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -164522,11 +164759,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *778 - installation: *779 - membership: *817 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + membership: *819 + organization: *782 + repository: *783 sender: *4 required: - action @@ -164605,8 +164842,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -164722,10 +164959,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 - user: *800 + user: *802 required: - action - invitation @@ -164803,11 +165040,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *778 - installation: *779 - membership: *817 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + membership: *819 + organization: *782 + repository: *783 sender: *4 required: - action @@ -164894,11 +165131,11 @@ x-webhooks: properties: from: type: string - enterprise: *778 - installation: *779 - membership: *817 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + membership: *819 + organization: *782 + repository: *783 sender: *4 required: - action @@ -164975,9 +165212,9 @@ x-webhooks: type: string enum: - published - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 package: description: Information about the package. type: object @@ -165476,7 +165713,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &818 + items: &820 title: Ruby Gems metadata type: object properties: @@ -165571,7 +165808,7 @@ x-webhooks: - owner - package_version - registry - repository: *781 + repository: *783 sender: *4 required: - action @@ -165647,9 +165884,9 @@ x-webhooks: type: string enum: - updated - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 package: description: Information about the package. type: object @@ -166002,7 +166239,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *818 + items: *820 source_url: type: string format: uri @@ -166072,7 +166309,7 @@ x-webhooks: - owner - package_version - registry - repository: *781 + repository: *783 sender: *4 required: - action @@ -166248,12 +166485,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *778 + enterprise: *780 id: type: integer - installation: *779 - organization: *780 - repository: *781 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - id @@ -166330,7 +166567,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &819 + personal_access_token_request: &821 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -166476,10 +166713,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *778 - organization: *780 + enterprise: *780 + organization: *782 sender: *4 - installation: *779 + installation: *781 required: - action - personal_access_token_request @@ -166556,11 +166793,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *819 - enterprise: *778 - organization: *780 + personal_access_token_request: *821 + enterprise: *780 + organization: *782 sender: *4 - installation: *779 + installation: *781 required: - action - personal_access_token_request @@ -166636,11 +166873,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *819 - enterprise: *778 - organization: *780 + personal_access_token_request: *821 + enterprise: *780 + organization: *782 sender: *4 - installation: *779 + installation: *781 required: - action - personal_access_token_request @@ -166715,11 +166952,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *819 - organization: *780 - enterprise: *778 + personal_access_token_request: *821 + organization: *782 + enterprise: *780 sender: *4 - installation: *779 + installation: *781 required: - action - personal_access_token_request @@ -166824,7 +167061,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *820 + last_response: *822 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -166856,8 +167093,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 zen: description: Random string of GitHub zen. @@ -167102,10 +167339,10 @@ x-webhooks: - from required: - note - enterprise: *778 - installation: *779 - organization: *780 - project_card: &821 + enterprise: *780 + installation: *781 + organization: *782 + project_card: &823 title: Project Card type: object properties: @@ -167224,7 +167461,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *781 + repository: *783 sender: *4 required: - action @@ -167305,11 +167542,11 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - organization: *780 - project_card: *821 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + project_card: *823 + repository: *783 sender: *4 required: - action @@ -167389,9 +167626,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 project_card: title: Project Card type: object @@ -167519,9 +167756,9 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *813 - required: *814 - x-github-breaking-changes: *815 + properties: *815 + required: *816 + x-github-breaking-changes: *817 nullable: true sender: *4 required: @@ -167615,11 +167852,11 @@ x-webhooks: - from required: - note - enterprise: *778 - installation: *779 - organization: *780 - project_card: *821 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + project_card: *823 + repository: *783 sender: *4 required: - action @@ -167713,9 +167950,9 @@ x-webhooks: - from required: - column_id - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 project_card: allOf: - title: Project Card @@ -167905,7 +168142,7 @@ x-webhooks: type: string required: - after_id - repository: *781 + repository: *783 sender: *4 required: - action @@ -167985,10 +168222,10 @@ x-webhooks: type: string enum: - closed - enterprise: *778 - installation: *779 - organization: *780 - project: &823 + enterprise: *780 + installation: *781 + organization: *782 + project: &825 title: Project type: object properties: @@ -168112,7 +168349,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *781 + repository: *783 sender: *4 required: - action @@ -168192,10 +168429,10 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - organization: *780 - project_column: &822 + enterprise: *780 + installation: *781 + organization: *782 + project_column: &824 title: Project Column type: object properties: @@ -168234,7 +168471,7 @@ x-webhooks: - name - created_at - updated_at - repository: *781 + repository: *783 sender: *4 required: - action @@ -168313,19 +168550,19 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - organization: *780 - project_column: *822 + enterprise: *780 + installation: *781 + organization: *782 + project_column: *824 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *813 - required: *814 - x-github-breaking-changes: *815 + properties: *815 + required: *816 + x-github-breaking-changes: *817 nullable: true sender: *4 required: @@ -168415,11 +168652,11 @@ x-webhooks: type: string required: - from - enterprise: *778 - installation: *779 - organization: *780 - project_column: *822 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + project_column: *824 + repository: *783 sender: *4 required: - action @@ -168499,11 +168736,11 @@ x-webhooks: type: string enum: - moved - enterprise: *778 - installation: *779 - organization: *780 - project_column: *822 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + project_column: *824 + repository: *783 sender: *4 required: - action @@ -168583,11 +168820,11 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - organization: *780 - project: *823 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + project: *825 + repository: *783 sender: *4 required: - action @@ -168667,19 +168904,19 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - organization: *780 - project: *823 + enterprise: *780 + installation: *781 + organization: *782 + project: *825 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *813 - required: *814 - x-github-breaking-changes: *815 + properties: *815 + required: *816 + x-github-breaking-changes: *817 nullable: true sender: *4 required: @@ -168781,11 +169018,11 @@ x-webhooks: type: string required: - from - enterprise: *778 - installation: *779 - organization: *780 - project: *823 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + project: *825 + repository: *783 sender: *4 required: - action @@ -168864,11 +169101,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *778 - installation: *779 - organization: *780 - project: *823 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + project: *825 + repository: *783 sender: *4 required: - action @@ -168949,8 +169186,8 @@ x-webhooks: type: string enum: - closed - installation: *779 - organization: *780 + installation: *781 + organization: *782 projects_v2: *292 sender: *4 required: @@ -169032,8 +169269,8 @@ x-webhooks: type: string enum: - created - installation: *779 - organization: *780 + installation: *781 + organization: *782 projects_v2: *292 sender: *4 required: @@ -169115,8 +169352,8 @@ x-webhooks: type: string enum: - deleted - installation: *779 - organization: *780 + installation: *781 + organization: *782 projects_v2: *292 sender: *4 required: @@ -169234,8 +169471,8 @@ x-webhooks: type: string to: type: string - installation: *779 - organization: *780 + installation: *781 + organization: *782 projects_v2: *292 sender: *4 required: @@ -169319,7 +169556,7 @@ x-webhooks: type: string enum: - archived - changes: &827 + changes: &829 type: object properties: archived_at: @@ -169333,9 +169570,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *779 - organization: *780 - projects_v2_item: &824 + installation: *781 + organization: *782 + projects_v2_item: &826 title: Projects v2 Item description: An item belonging to a project type: object @@ -169470,9 +169707,9 @@ x-webhooks: nullable: true to: type: string - installation: *779 - organization: *780 - projects_v2_item: *824 + installation: *781 + organization: *782 + projects_v2_item: *826 sender: *4 required: - action @@ -169554,9 +169791,9 @@ x-webhooks: type: string enum: - created - installation: *779 - organization: *780 - projects_v2_item: *824 + installation: *781 + organization: *782 + projects_v2_item: *826 sender: *4 required: - action @@ -169637,9 +169874,9 @@ x-webhooks: type: string enum: - deleted - installation: *779 - organization: *780 - projects_v2_item: *824 + installation: *781 + organization: *782 + projects_v2_item: *826 sender: *4 required: - action @@ -169745,7 +169982,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &825 + - &827 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -169767,7 +170004,7 @@ x-webhooks: required: - id - name - - &826 + - &828 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -169801,8 +170038,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *825 - - *826 + - *827 + - *828 required: - field_value - type: object @@ -169818,9 +170055,9 @@ x-webhooks: nullable: true required: - body - installation: *779 - organization: *780 - projects_v2_item: *824 + installation: *781 + organization: *782 + projects_v2_item: *826 sender: *4 required: - action @@ -169915,9 +170152,9 @@ x-webhooks: to: type: string nullable: true - installation: *779 - organization: *780 - projects_v2_item: *824 + installation: *781 + organization: *782 + projects_v2_item: *826 sender: *4 required: - action @@ -170000,10 +170237,10 @@ x-webhooks: type: string enum: - restored - changes: *827 - installation: *779 - organization: *780 - projects_v2_item: *824 + changes: *829 + installation: *781 + organization: *782 + projects_v2_item: *826 sender: *4 required: - action @@ -170085,8 +170322,8 @@ x-webhooks: type: string enum: - reopened - installation: *779 - organization: *780 + installation: *781 + organization: *782 projects_v2: *292 sender: *4 required: @@ -170168,14 +170405,14 @@ x-webhooks: type: string enum: - created - installation: *779 - organization: *780 - projects_v2_status_update: &830 + installation: *781 + organization: *782 + projects_v2_status_update: &832 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *828 - required: *829 + properties: *830 + required: *831 sender: *4 required: - action @@ -170256,9 +170493,9 @@ x-webhooks: type: string enum: - deleted - installation: *779 - organization: *780 - projects_v2_status_update: *830 + installation: *781 + organization: *782 + projects_v2_status_update: *832 sender: *4 required: - action @@ -170394,9 +170631,9 @@ x-webhooks: type: string format: date nullable: true - installation: *779 - organization: *780 - projects_v2_status_update: *830 + installation: *781 + organization: *782 + projects_v2_status_update: *832 sender: *4 required: - action @@ -170467,10 +170704,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - repository @@ -170547,13 +170784,13 @@ x-webhooks: type: string enum: - assigned - assignee: *800 - enterprise: *778 - installation: *779 - number: &831 + assignee: *802 + enterprise: *780 + installation: *781 + number: &833 description: The pull request number. type: integer - organization: *780 + organization: *782 pull_request: title: Pull Request type: object @@ -172858,7 +173095,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 sender: *4 required: - action @@ -172955,11 +173192,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 number: type: integer - organization: *780 + organization: *782 pull_request: title: Pull Request type: object @@ -175259,7 +175496,7 @@ x-webhooks: - draft reason: type: string - repository: *781 + repository: *783 sender: *4 required: - action @@ -175356,11 +175593,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 number: type: integer - organization: *780 + organization: *782 pull_request: title: Pull Request type: object @@ -177660,7 +177897,7 @@ x-webhooks: - draft reason: type: string - repository: *781 + repository: *783 sender: *4 required: - action @@ -177757,11 +177994,11 @@ x-webhooks: type: string enum: - closed - enterprise: *778 - installation: *779 - number: *831 - organization: *780 - pull_request: &832 + enterprise: *780 + installation: *781 + number: *833 + organization: *782 + pull_request: &834 allOf: - *628 - type: object @@ -177825,7 +178062,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *781 + repository: *783 sender: *4 required: - action @@ -177906,12 +178143,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *778 - installation: *779 - number: *831 - organization: *780 - pull_request: *832 - repository: *781 + enterprise: *780 + installation: *781 + number: *833 + organization: *782 + pull_request: *834 + repository: *783 sender: *4 required: - action @@ -177991,11 +178228,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *778 + enterprise: *780 milestone: *612 - number: *831 - organization: *780 - pull_request: &833 + number: *833 + organization: *782 + pull_request: &835 title: Pull Request type: object properties: @@ -180322,7 +180559,7 @@ x-webhooks: - active_lock_reason - draft version: '2026-03-10' - repository: *781 + repository: *783 sender: *4 required: - action @@ -180401,11 +180638,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 number: type: integer - organization: *780 + organization: *782 pull_request: title: Pull Request type: object @@ -182709,7 +182946,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *781 + repository: *783 sender: *4 required: - action @@ -182841,12 +183078,12 @@ x-webhooks: type: string required: - from - enterprise: *778 - installation: *779 - number: *831 - organization: *780 - pull_request: *832 - repository: *781 + enterprise: *780 + installation: *781 + number: *833 + organization: *782 + pull_request: *834 + repository: *783 sender: *4 required: - action @@ -182926,11 +183163,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 number: type: integer - organization: *780 + organization: *782 pull_request: title: Pull Request type: object @@ -185219,7 +185456,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 sender: *4 required: - action @@ -185307,11 +185544,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *778 - installation: *779 - label: *799 - number: *831 - organization: *780 + enterprise: *780 + installation: *781 + label: *801 + number: *833 + organization: *782 pull_request: title: Pull Request type: object @@ -187615,7 +187852,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 sender: *4 required: - action @@ -187711,10 +187948,10 @@ x-webhooks: type: string enum: - locked - enterprise: *778 - installation: *779 - number: *831 - organization: *780 + enterprise: *780 + installation: *781 + number: *833 + organization: *782 pull_request: title: Pull Request type: object @@ -190016,7 +190253,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 sender: *4 required: - action @@ -190111,12 +190348,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *778 + enterprise: *780 milestone: *612 - number: *831 - organization: *780 - pull_request: *833 - repository: *781 + number: *833 + organization: *782 + pull_request: *835 + repository: *783 sender: *4 required: - action @@ -190195,12 +190432,12 @@ x-webhooks: type: string enum: - opened - enterprise: *778 - installation: *779 - number: *831 - organization: *780 - pull_request: *832 - repository: *781 + enterprise: *780 + installation: *781 + number: *833 + organization: *782 + pull_request: *834 + repository: *783 sender: *4 required: - action @@ -190281,12 +190518,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *778 - installation: *779 - number: *831 - organization: *780 - pull_request: *832 - repository: *781 + enterprise: *780 + installation: *781 + number: *833 + organization: *782 + pull_request: *834 + repository: *783 sender: *4 required: - action @@ -190366,12 +190603,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *778 - installation: *779 - number: *831 - organization: *780 - pull_request: *832 - repository: *781 + enterprise: *780 + installation: *781 + number: *833 + organization: *782 + pull_request: *834 + repository: *783 sender: *4 required: - action @@ -190737,9 +190974,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 pull_request: type: object properties: @@ -192931,7 +193168,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *781 + repository: *783 sender: *4 required: - action @@ -193026,7 +193263,7 @@ x-webhooks: type: string enum: - deleted - comment: &835 + comment: &837 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -193311,9 +193548,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 pull_request: type: object properties: @@ -195493,7 +195730,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *781 + repository: *783 sender: *4 required: - action @@ -195588,11 +195825,11 @@ x-webhooks: type: string enum: - edited - changes: *834 - comment: *835 - enterprise: *778 - installation: *779 - organization: *780 + changes: *836 + comment: *837 + enterprise: *780 + installation: *781 + organization: *782 pull_request: type: object properties: @@ -197775,7 +198012,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *781 + repository: *783 sender: *4 required: - action @@ -197871,9 +198108,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 pull_request: title: Simple Pull Request type: object @@ -200068,7 +200305,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *781 + repository: *783 review: description: The review that was affected. type: object @@ -200330,9 +200567,9 @@ x-webhooks: type: string required: - from - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 pull_request: title: Simple Pull Request type: object @@ -202386,8 +202623,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *781 - review: &836 + repository: *783 + review: &838 description: The review that was affected. type: object properties: @@ -202628,12 +202865,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 number: description: The pull request number. type: integer - organization: *780 + organization: *782 pull_request: title: Pull Request type: object @@ -204938,7 +205175,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 requested_reviewer: title: User type: object @@ -205022,12 +205259,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 number: description: The pull request number. type: integer - organization: *780 + organization: *782 pull_request: title: Pull Request type: object @@ -207339,7 +207576,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 requested_team: title: Team description: Groups of organization members that gives permissions @@ -207554,12 +207791,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 number: description: The pull request number. type: integer - organization: *780 + organization: *782 pull_request: title: Pull Request type: object @@ -209866,7 +210103,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 requested_reviewer: title: User type: object @@ -209951,12 +210188,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *778 - installation: *779 + enterprise: *780 + installation: *781 number: description: The pull request number. type: integer - organization: *780 + organization: *782 pull_request: title: Pull Request type: object @@ -212254,7 +212491,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 requested_team: title: Team description: Groups of organization members that gives permissions @@ -212458,9 +212695,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 pull_request: title: Simple Pull Request type: object @@ -214657,8 +214894,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *781 - review: *836 + repository: *783 + review: *838 sender: *4 required: - action @@ -214753,9 +214990,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 pull_request: title: Simple Pull Request type: object @@ -216847,7 +217084,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *781 + repository: *783 sender: *4 thread: type: object @@ -217242,9 +217479,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 pull_request: title: Simple Pull Request type: object @@ -219322,7 +219559,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *781 + repository: *783 sender: *4 thread: type: object @@ -219654,7 +219891,7 @@ x-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. @@ -219662,10 +219899,8 @@ x-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: @@ -219709,21 +219944,17 @@ x-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: *778 - installation: *779 - number: *831 - organization: *780 + - stacked + enterprise: *780 + installation: *781 + number: *833 + organization: *782 pull_request: title: Pull Request type: object @@ -220717,12 +220948,14 @@ x-webhooks: properties: label: type: string + nullable: true ref: type: string repo: title: Repository description: A git repository type: object + nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -220932,15 +221165,23 @@ x-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 @@ -221438,6 +221679,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -222016,13 +222258,11 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 sender: *4 required: - action - number - - before - - after - pull_request - repository - sender @@ -222053,7 +222293,7 @@ x-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. @@ -222061,8 +222301,10 @@ x-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: @@ -222106,18 +222348,21 @@ x-webhooks: content: application/json: schema: - title: pull_request unassigned event + title: pull_request synchronize event type: object properties: action: type: string enum: - - unassigned - assignee: *837 - enterprise: *778 - installation: *779 - number: *831 - organization: *780 + - synchronize + after: + type: string + before: + type: string + enterprise: *780 + installation: *781 + number: *833 + organization: *782 pull_request: title: Pull Request type: object @@ -222470,7 +222715,6 @@ x-webhooks: properties: label: type: string - nullable: true ref: type: string repo: @@ -223112,14 +223356,12 @@ x-webhooks: properties: label: type: string - nullable: true ref: type: string repo: title: Repository description: A git repository type: object - nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -223329,23 +223571,15 @@ x-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 @@ -223843,7 +224077,6 @@ x-webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -224422,13 +224655,16 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 sender: *4 required: - action - number + - before + - after - pull_request - repository + - sender x-github-breaking-changes: - changeset: remove_use_squash_pr_title_as_default patch: @@ -224456,7 +224692,7 @@ x-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. @@ -224464,8 +224700,8 @@ x-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: @@ -224509,18 +224745,18 @@ x-webhooks: content: application/json: schema: - title: pull_request unlabeled event + title: pull_request unassigned event type: object properties: action: type: string enum: - - unlabeled - enterprise: *778 - installation: *779 - label: *799 - number: *831 - organization: *780 + - unassigned + assignee: *839 + enterprise: *780 + installation: *781 + number: *833 + organization: *782 pull_request: title: Pull Request type: object @@ -224873,6 +225109,7 @@ x-webhooks: properties: label: type: string + nullable: true ref: type: string repo: @@ -225731,15 +225968,23 @@ x-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 @@ -226237,6 +226482,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -226815,14 +227061,13 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 sender: *4 required: - action - number - pull_request - repository - - sender x-github-breaking-changes: - changeset: remove_use_squash_pr_title_as_default patch: @@ -226850,7 +227095,7 @@ x-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. @@ -226858,9 +227103,8 @@ x-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: @@ -226904,17 +227148,18 @@ x-webhooks: content: application/json: schema: - title: pull_request unlocked event + title: pull_request unlabeled event type: object properties: action: type: string enum: - - unlocked - enterprise: *778 - installation: *779 - number: *831 - organization: *780 + - unlabeled + enterprise: *780 + installation: *781 + label: *801 + number: *833 + organization: *782 pull_request: title: Pull Request type: object @@ -227075,6 +227320,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -227146,6 +227392,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -227178,6 +227425,7 @@ x-webhooks: commit_title: description: Title for the merge commit message. type: string + nullable: true enabled_by: title: User type: object @@ -227905,6 +228153,7 @@ x-webhooks: properties: label: type: string + nullable: true ref: type: string repo: @@ -228121,23 +228370,15 @@ x-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 @@ -228719,6 +228960,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -228857,6 +229099,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -228965,6 +229208,15 @@ x-webhooks: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -229156,6 +229408,7 @@ x-webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -229201,7 +229454,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *781 + repository: *783 sender: *4 required: - action @@ -229236,20 +229489,19 @@ x-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 @@ -229263,7 +229515,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: push + example: pull_request schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -229291,487 +229543,2874 @@ x-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 - nullable: true - 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 - nullable: true - 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 - nullable: true - 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. + action: type: string - created: - description: Whether this push created the `ref`. - type: boolean - deleted: - description: Whether this push deleted the `ref`. - type: boolean - enterprise: *778 - forced: - description: Whether this push was a force push of the `ref`. - type: boolean - head_commit: - title: Commit + enum: + - unlocked + enterprise: *780 + installation: *781 + number: *833 + organization: *782 + pull_request: + title: Pull Request type: object - nullable: true 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 - nullable: true - 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. + _links: type: object properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string + 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: - - 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: *779 - organization: *780 - pusher: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - 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: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: type: string nullable: true - 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 - nullable: true - 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 - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - 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 - nullable: true - 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: + - resolved + - off-topic + - too heated + - spam + - null + additions: type: integer - organization: - type: string - owner: + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + 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 + nullable: true + properties: + commit_message: + description: Commit message for the merge commit. + type: string + nullable: true + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + changed_files: + type: integer + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + 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: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - 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 + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull + request. + type: boolean + merge_commit_sha: + type: string + nullable: true + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true + merged_at: + type: string + nullable: true + format: date-time + merged_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within + its repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: boolean + nullable: true + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - 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: *783 + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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: *780 + forced: + description: Whether this push was a force push of the `ref`. + type: boolean + head_commit: + title: Commit + type: object + nullable: true + 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 + nullable: true + 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 + nullable: true + 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: *781 + organization: *782 + pusher: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + 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 + nullable: true + 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 nullable: true @@ -230095,9 +232734,9 @@ x-webhooks: type: string enum: - published - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 registry_package: type: object properties: @@ -230543,7 +233182,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *818 + items: *820 summary: type: string tag_name: @@ -230597,7 +233236,7 @@ x-webhooks: - owner - package_version - registry - repository: *781 + repository: *783 sender: *4 required: - action @@ -230675,9 +233314,9 @@ x-webhooks: type: string enum: - updated - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 registry_package: type: object properties: @@ -230985,7 +233624,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *818 + items: *820 summary: type: string tag_name: @@ -231034,7 +233673,7 @@ x-webhooks: - owner - package_version - registry - repository: *781 + repository: *783 sender: *4 required: - action @@ -231111,10 +233750,10 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - organization: *780 - release: &838 + enterprise: *780 + installation: *781 + organization: *782 + release: &840 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -231432,7 +234071,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *781 + repository: *783 sender: *4 required: - action @@ -231509,11 +234148,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - organization: *780 - release: *838 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + release: *840 + repository: *783 sender: *4 required: - action @@ -231630,11 +234269,11 @@ x-webhooks: type: boolean required: - to - enterprise: *778 - installation: *779 - organization: *780 - release: *838 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + release: *840 + repository: *783 sender: *4 required: - action @@ -231712,9 +234351,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -232036,7 +234675,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *781 + repository: *783 sender: *4 required: - action @@ -232112,10 +234751,10 @@ x-webhooks: type: string enum: - published - enterprise: *778 - installation: *779 - organization: *780 - release: &839 + enterprise: *780 + installation: *781 + organization: *782 + release: &841 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -232434,7 +235073,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *781 + repository: *783 sender: *4 required: - action @@ -232510,11 +235149,11 @@ x-webhooks: type: string enum: - released - enterprise: *778 - installation: *779 - organization: *780 - release: *838 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + release: *840 + repository: *783 sender: *4 required: - action @@ -232590,11 +235229,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *778 - installation: *779 - organization: *780 - release: *839 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + release: *841 + repository: *783 sender: *4 required: - action @@ -232670,11 +235309,11 @@ x-webhooks: type: string enum: - published - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 - repository_advisory: *698 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 + repository_advisory: *700 sender: *4 required: - action @@ -232750,11 +235389,11 @@ x-webhooks: type: string enum: - reported - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 - repository_advisory: *698 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 + repository_advisory: *700 sender: *4 required: - action @@ -232830,10 +235469,10 @@ x-webhooks: type: string enum: - archived - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -232910,10 +235549,10 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -232991,10 +235630,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -233078,10 +235717,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -233193,10 +235832,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -233268,10 +235907,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 status: type: string @@ -233352,10 +235991,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -233432,10 +236071,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -233529,10 +236168,10 @@ x-webhooks: - name required: - repository - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -233612,10 +236251,10 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 repository_ruleset: *341 sender: *4 required: @@ -233694,10 +236333,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 repository_ruleset: *341 sender: *4 required: @@ -233776,10 +236415,10 @@ x-webhooks: type: string enum: - edited - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 repository_ruleset: *341 changes: type: object @@ -234084,10 +236723,10 @@ x-webhooks: - from required: - owner - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -234165,10 +236804,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -234246,7 +236885,7 @@ x-webhooks: type: string enum: - create - alert: &840 + alert: &842 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -234368,10 +237007,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -234577,10 +237216,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -234658,11 +237297,11 @@ x-webhooks: type: string enum: - reopen - alert: *840 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + alert: *842 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -234861,10 +237500,10 @@ x-webhooks: enum: - fixed - open - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -234942,7 +237581,7 @@ x-webhooks: type: string enum: - assigned - alert: &841 + alert: &844 type: object properties: number: *188 @@ -235084,11 +237723,12 @@ x-webhooks: properties: *20 required: *21 nullable: true + metadata: *843 assignee: *4 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -235166,11 +237806,11 @@ x-webhooks: type: string enum: - created - alert: *841 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + alert: *844 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -235251,11 +237891,11 @@ x-webhooks: type: string enum: - created - alert: *841 - installation: *779 - location: *842 - organization: *780 - repository: *781 + alert: *844 + installation: *781 + location: *845 + organization: *782 + repository: *783 sender: *4 required: - location @@ -235433,6 +238073,168 @@ x-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: *844 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 + 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: *844 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 + 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: |- @@ -235493,11 +238295,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *841 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + alert: *844 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -235575,11 +238377,11 @@ x-webhooks: type: string enum: - reopened - alert: *841 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + alert: *844 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -235657,11 +238459,11 @@ x-webhooks: type: string enum: - resolved - alert: *841 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + alert: *844 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -235739,12 +238541,12 @@ x-webhooks: type: string enum: - unassigned - alert: *841 + alert: *844 assignee: *4 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -235822,11 +238624,11 @@ x-webhooks: type: string enum: - validated - alert: *841 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + alert: *844 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -235952,10 +238754,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *781 - enterprise: *778 - installation: *779 - organization: *780 + repository: *783 + enterprise: *780 + installation: *781 + organization: *782 sender: *4 required: - action @@ -236033,11 +238835,11 @@ x-webhooks: type: string enum: - published - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 - security_advisory: &843 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 + security_advisory: &846 description: The details of the security advisory, including summary, description, and severity. type: object @@ -236238,11 +239040,11 @@ x-webhooks: type: string enum: - updated - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 - security_advisory: *843 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 + security_advisory: *846 sender: *4 required: - action @@ -236315,10 +239117,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -236511,9 +239313,9 @@ x-webhooks: type: object properties: security_and_analysis: *314 - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 repository: *359 sender: *4 required: @@ -236592,12 +239394,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 - sponsorship: &844 + sponsorship: &847 type: object properties: created_at: @@ -236898,12 +239700,12 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 - sponsorship: *844 + sponsorship: *847 required: - action - sponsorship @@ -236991,12 +239793,12 @@ x-webhooks: type: string required: - from - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 - sponsorship: *844 + sponsorship: *847 required: - action - changes @@ -237073,17 +239875,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &845 + effective_date: &848 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: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 - sponsorship: *844 + sponsorship: *847 required: - action - sponsorship @@ -237157,7 +239959,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &846 + changes: &849 type: object properties: tier: @@ -237201,13 +240003,13 @@ x-webhooks: - from required: - tier - effective_date: *845 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + effective_date: *848 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 - sponsorship: *844 + sponsorship: *847 required: - action - changes @@ -237284,13 +240086,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *846 - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + changes: *849 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 - sponsorship: *844 + sponsorship: *847 required: - action - changes @@ -237364,10 +240166,10 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -237450,10 +240252,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -237873,15 +240675,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *778 + enterprise: *780 id: description: The unique identifier of the status. type: integer - installation: *779 + installation: *781 name: type: string - organization: *780 - repository: *781 + organization: *782 + repository: *783 sender: *4 sha: description: The Commit SHA. @@ -237996,9 +240798,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *779 - organization: *780 - repository: *781 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -238087,9 +240889,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *779 - organization: *780 - repository: *781 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -238178,9 +240980,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *779 - organization: *780 - repository: *781 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -238269,9 +241071,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *779 - organization: *780 - repository: *781 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -238347,12 +241149,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 - team: &847 + team: &850 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -238575,9 +241377,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 repository: title: Repository description: A git repository @@ -239035,7 +241837,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *847 + team: *850 required: - action - team @@ -239111,9 +241913,9 @@ x-webhooks: type: string enum: - created - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 repository: title: Repository description: A git repository @@ -239571,7 +242373,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *847 + team: *850 required: - action - team @@ -239648,9 +242450,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 repository: title: Repository description: A git repository @@ -240108,7 +242910,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *847 + team: *850 required: - action - team @@ -240252,9 +243054,9 @@ x-webhooks: - from required: - permissions - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 repository: title: Repository description: A git repository @@ -240712,7 +243514,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *847 + team: *850 required: - action - changes @@ -240790,9 +243592,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *778 - installation: *779 - organization: *780 + enterprise: *780 + installation: *781 + organization: *782 repository: title: Repository description: A git repository @@ -241250,7 +244052,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *847 + team: *850 required: - action - team @@ -241326,10 +244128,10 @@ x-webhooks: type: string enum: - started - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 required: - action @@ -241402,16 +244204,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *778 + enterprise: *780 inputs: type: object nullable: true additionalProperties: true - installation: *779 - organization: *780 + installation: *781 + organization: *782 ref: type: string - repository: *781 + repository: *783 sender: *4 workflow: type: string @@ -241493,10 +244295,10 @@ x-webhooks: type: string enum: - completed - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 workflow_job: allOf: @@ -241812,10 +244614,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 workflow_job: allOf: @@ -242154,10 +244956,10 @@ x-webhooks: type: string enum: - queued - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 workflow_job: type: object @@ -242371,10 +245173,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 workflow_job: type: object @@ -242590,12 +245392,12 @@ x-webhooks: type: string enum: - completed - enterprise: *778 - installation: *779 - organization: *780 - repository: *781 + enterprise: *780 + installation: *781 + organization: *782 + repository: *783 sender: *4 - workflow: *795 + workflow: *797 workflow_run: title: Workflow Run type: object @@ -243594,12 +246396,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *{"code":"deadline_exceeded","msg":"operation timed out"}